> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # Append a message and start an agent run > Requires the workspace-agent deployment, rollout and feature flag plus a current Tali/Aida access permission. Conversation resources require an active human participant in the same tenant; inaccessible resources are concealed. conversation_id must be present: null starts a conversation, an existing UUID requires If-Match with its quoted conversation revision ETag. Only documented input keys and text parts are accepted; caller-authored client/actor/history/tools/state/credentials are rejected. A UUID Idempotency-Key protects exact command replay.202 returns the queued run and event-stream URL, with updated ETag. ## OpenAPI ````yaml post /admin/workspace-agent/runs openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity commitment relationships, lifecycle transitions, and commitment-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Events description: >- Event setup, invitations, registration, ticketing, attendance and event reporting. - name: Journeys description: >- Journey graphs, activation, enrollment, message templates and event follow-up automations. - name: Tasks description: Workspace tasks, assignments, saved task views and record collaboration. - name: Fundraising description: >- Fundraising portfolios, stewardship plans, giving anniversaries and personal donor follow-up. - name: Impact Stories description: Story intake, review, assets, consent and publication workflows. - name: Integrations description: Workspace integration connections, mappings, synchronization and recovery. - name: Email Calendar description: Connected email/calendar accounts and donor interactions. - name: Spaces description: Workspace Spaces and collaborative Pages. - name: Library description: Workspace documents, source connections, files and analysis. - name: Intelligence description: Donor intelligence and Tali workspace workflows. - name: Automation description: >- V3 automation primitive discovery, input validation, invocation and Zapier contracts. - name: Schema description: V3 model, enum, capability and scope discovery. - name: Zapier description: Zapier automation connections, polling feeds and actions. - name: Files description: Files - name: Client description: Client - name: Payment Gateways description: Payment Gateways - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Recipients description: Recipients - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Settings description: Settings - name: Notifications description: Notifications - name: Participation description: Participation - name: Users description: Users - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User - name: Workspace description: Workspace paths: /admin/workspace-agent/runs: post: tags: - Intelligence summary: Append a message and start an agent run description: >- Requires the workspace-agent deployment, rollout and feature flag plus a current Tali/Aida access permission. Conversation resources require an active human participant in the same tenant; inaccessible resources are concealed. conversation_id must be present: null starts a conversation, an existing UUID requires If-Match with its quoted conversation revision ETag. Only documented input keys and text parts are accepted; caller-authored client/actor/history/tools/state/credentials are rejected. A UUID Idempotency-Key protects exact command replay.202 returns the queued run and event-stream URL, with updated ETag. operationId: docWorkspaceAgentConversationStoreRunPOST parameters: - name: Idempotency-Key in: header description: Request key; replay the same key only with the same payload. required: true schema: type: string format: uuid example: 018fd5a0-1331-7000-8000-000000000123 - name: If-Match in: header description: >- Conversation ETag from show or a previous accepted command, formatted as conversation::revision: inside double quotes. required: false schema: type: string example: conversation:018fd5a0-1331-7000-8000-000000000123:revision:1 requestBody: description: >- Request fields accepted by this operation. Omitted optional properties retain the behavior described above. required: true content: application/json: schema: required: - conversation_id - agent_id - input properties: conversation_id: description: 'Validation: `present|nullable|uuid`.' type: string format: uuid nullable: true agent_id: description: 'Validation: `required|uuid`.' type: string format: uuid reply_to_message_id: description: 'Validation: `nullable|uuid`.' type: string format: uuid nullable: true input: required: - content properties: content: type: array items: required: - type - text properties: type: description: 'Validation: `required|in:text`.' type: string enum: - text text: description: 'Validation: `required|string|min:1|max:24000`.' type: string maxLength: 24000 minLength: 1 type: object additionalProperties: false maxItems: 16 minItems: 1 reaction: required: - name - action - target_message_id properties: name: description: 'Validation: `required|in:+1,heart,tada`.' type: string enum: - '+1' - heart - tada action: description: 'Validation: `required|in:added,removed`.' type: string enum: - added - removed target_message_id: description: 'Validation: `required|uuid`.' type: string format: uuid type: object type: object additionalProperties: false type: object additionalProperties: false responses: '202': description: Append a message and start an agent run response. content: application/json: schema: properties: data: properties: conversation_id: type: string conversation_revision: type: integer message_id: type: string message_sequence: type: integer run_id: type: string run_sequence: type: integer run_state: type: string events_url: type: string type: object type: object '401': description: Missing or invalid bearer token or API key. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '403': description: >- The caller lacks the required permission, resource access or feature availability. content: application/json: schema: properties: error: properties: code: type: string message: type: string details: description: >- Protocol-specific details such as current_revision or current_version. type: object additionalProperties: true type: object type: object '404': description: >- The organization-owned resource or parent was not found or is not available for this operation. content: application/json: schema: properties: error: properties: code: type: string message: type: string details: description: >- Protocol-specific details such as current_revision or current_version. type: object additionalProperties: true type: object type: object '409': description: >- The request conflicts with the current resource state or service configuration. content: application/json: schema: properties: error: properties: code: type: string message: type: string details: description: >- Protocol-specific details such as current_revision or current_version. type: object additionalProperties: true type: object type: object '422': description: Request validation or a domain constraint failed. content: application/json: schema: oneOf: - properties: error: properties: code: type: string message: type: string details: description: >- Protocol-specific details such as current_revision or current_version. type: object additionalProperties: true type: object type: object - $ref: '#/components/schemas/ValidationErrorResponse' '428': description: Operation could not be completed. content: application/json: schema: properties: error: properties: code: type: string message: type: string details: description: >- Protocol-specific details such as current_revision or current_version. type: object additionalProperties: true type: object type: object '503': description: >- The provider or background processing service is temporarily unavailable. content: application/json: schema: properties: error: properties: code: type: string message: type: string details: description: >- Protocol-specific details such as current_revision or current_version. type: object additionalProperties: true type: object type: object security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: UnauthorizedResponse: title: UnauthorizedResponse description: >- Returned with HTTP 401 when the request lacks a valid Passport bearer token, a valid `X-HYS-API-Key`, or a valid session. The body is the simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`. required: - message - status properties: message: description: >- Always the literal string `Unauthorized` from the `auth.api_or_key` middleware. Login endpoints return `Invalid Credentials` instead. type: string example: Unauthorized status: type: string example: error type: object ValidationErrorResponse: title: ValidationErrorResponse description: >- Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The `errors` map is keyed by the failing field name; each value is an array of human-readable error messages for that field. Most controllers also include a top-level `status: error`. required: - errors properties: errors: description: >- Map of field name to array of validator error messages. Example: `{email: [The email field is required.], amount: [The amount must be a number.]}`. type: object additionalProperties: type: array items: type: string status: description: Always the literal string `error`. type: string example: error message: description: >- Optional summary message — present on some endpoints, absent on others. type: string example: The given data was invalid. nullable: true type: object securitySchemes: bearerAuth: type: http description: Passport bearer token authentication for legacy admin sessions. scheme: bearer bearerFormat: JWT apiKeyAuth: type: apiKey description: Gratona API key sent with the compatibility header X-HYS-API-Key. name: X-HYS-API-Key in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.