> ## Documentation Index > Fetch the complete documentation index at: https://docs.aide.app/llms.txt > Use this file to discover all available pages before exploring further. # Post v1agents ## OpenAPI ````yaml /api-reference/openapi.json post /v1/agents openapi: 3.1.0 info: title: Aide API version: '1' description: >- Aide's public API. The dashboard, personal access tokens and the MCP server all use these endpoints. **Authentication.** `Authorization: Bearer oat_…` (a teammate's access token) or `Authorization: Bearer aide_live_…` (a workspace API key, created by an owner or admin under Settings > Developers). Either is bound to one account; every resource is scoped to it, and another account's id answers 404. **API keys** act as the workspace, not as a teammate. Operations that list `apiKey` under security accept them; everything else (the session, `me`, members, teams, billing, conversations, saved views, notifications, helpdesk and widget settings, and API keys themselves) answers 403 `api_key_not_allowed`. A key with only the `read` scope gets 403 `insufficient_scope` on writes (every method but `GET`, except `POST /v1/knowledge/search`, which only reads). A revoked, expired or unknown key answers 401 `invalid_api_key`. Requests are rate limited per key. **Webhooks.** Each delivery is a `POST` of the event JSON with `Aide-Event-Id`, `Aide-Event-Type`, `Aide-Delivery-Attempt` and `Aide-Signature: t=,v1=`. `v1` is the HMAC-SHA256 of `${t}.${raw body}` keyed with the endpoint secret (`whsec_…`, the whole string). For 24 h after a rotation a second `v1`, signed with the previous secret, is included; accept the request if any `v1` matches and `t` is within 5 minutes. Answer 2xx within 10 s; anything else is retried with exponential backoff (8 attempts over about 4 h). An endpoint is disabled after 25 failed attempts in a row with no success for 24 h. Deduplicate on the event id. **Responses.** Successful bodies are wrapped as `{ data }`. Page-numbered lists add `metadata`: `total` (exact up to 10,000, then 10,000 with `totalIsCapped: true`), `totalIsCapped`, `perPage`, `currentPage`, `lastPage` and `hasMore`. `page` runs from 1 to 500, and a page that starts past the first 10,000 rows answers 422 `page_too_deep`. `GET /v1/conversations` also takes a `cursor` (not with `page`): its `metadata.nextCursor` pages on in the same sort without counting, and a cursor page has null `total`, `currentPage` and `lastPage`. Message threads page with `before` and `meta.nextCursor`. **Errors.** Every error is `{ error: { type, code, message, requestId, fields? } }`. Validation failures are 422 with one entry per field in `fields`. **Rate limits.** Throttled routes return `X-RateLimit-Limit` and `X-RateLimit-Remaining`; a 429 adds `Retry-After` and `X-RateLimit-Reset`. servers: - url: https://app-api.aide.app description: Aide API security: [] tags: - name: Account - name: Agent - name: AgentEntryPoint - name: AgentLinks - name: AgentPanelEvent - name: AgentPanelSessions - name: AgentTestConversation - name: Analytics - name: ApiKey - name: Attachment - name: Auth - name: Billing - name: ChannelActivity - name: ChannelConfiguration - name: ChannelSettings - name: ConnectedApp - name: ContactSync - name: Conversation - name: ConversationAi - name: ConversationCustomerContext - name: ConversationDraft - name: ConversationMacro - name: ConversationOrder - name: CustomField - name: EmailMailbox - name: EmailPreferences - name: GoogleSessions - name: HelpdeskSetting - name: Integration - name: IntegrationAiAgentRule - name: IntegrationSidebar - name: Invitation - name: KnowledgeCollection - name: KnowledgeDocument - name: KnowledgeEntity - name: KnowledgeSource - name: Macro - name: Me - name: Member - name: MessageFeedback - name: MessageSender - name: Notification - name: NotificationChannel - name: OauthAuthorization - name: Order - name: OrderAction - name: Plan - name: PolicyQuestion - name: Product - name: ProductPairing - name: Proposal - name: ReplyTemplate - name: RoutingRule - name: SavedView - name: Scenario - name: ScenarioBackfill - name: Schedule - name: SenderClassification - name: SenderRule - name: ShopifyStaffLinks - name: SlaPolicy - name: Team - name: Topic - name: TopicSuggestion - name: WebhookEndpoint - name: Widgets paths: /v1/agents: post: tags: - Agent operationId: agent.store requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 120 description: type: - string - 'null' maxLength: 500 instructions: type: - string - 'null' maxLength: 20000 greeting: type: - string - 'null' maxLength: 2000 botIdentifier: type: - string - 'null' maxLength: 60 teamName: type: - string - 'null' maxLength: 120 signature: type: - string - 'null' maxLength: 2000 contactInformation: type: - string - 'null' maxLength: 2000 usePastTickets: enum: - '1' - 1 - 'true' - true - 'on' - '0' - 0 - 'false' - false autoReply: enum: - '1' - 1 - 'true' - true - 'on' - '0' - 0 - 'false' - false model: anyOf: - enum: - fast - standard - type: 'null' knowledgeSetNames: type: array items: type: string minLength: 1 maxLength: 120 maxItems: 50 uniqueItems: true suggestedActions: type: array items: type: object properties: shortcut: type: string minLength: 1 maxLength: 80 question: type: string minLength: 1 maxLength: 500 required: - shortcut - question additionalProperties: false maxItems: 10 collectedFields: type: array items: type: object properties: fieldId: type: string maxLength: 64 mode: enum: - extract - ask_if_missing - always_ask required: enum: - '1' - 1 - 'true' - true - 'on' - '0' - 0 - 'false' - false required: - fieldId additionalProperties: false maxItems: 50 uniqueItems: true required: - name responses: '201': description: Created headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Agent' required: - data '401': $ref: '#/components/responses/Unauthenticated' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/TooManyRequests' default: $ref: '#/components/responses/Error' security: - accessToken: [] components: headers: X-RateLimit-Limit: description: Requests allowed in the current window. schema: type: integer X-RateLimit-Remaining: description: Requests left in the current window. schema: type: integer Retry-After: description: Seconds until the window resets. schema: type: integer X-RateLimit-Reset: description: When the window resets. schema: type: string format: date-time schemas: Agent: type: object properties: object: type: string const: agent name: type: string createdAt: type: - string - 'null' id: type: string status: type: string enum: - deployed - draft - paused updatedAt: type: - string - 'null' signature: type: - string - 'null' description: type: - string - 'null' model: type: - string - 'null' enum: - fast - standard - null autoReply: type: boolean knowledgeSetNames: type: array items: type: string usePastTickets: type: boolean teamName: type: - string - 'null' suggestedActions: type: array items: type: object properties: question: type: string shortcut: type: string required: - question - shortcut collectedFields: type: array items: type: object properties: required: type: boolean key: type: string mode: type: string enum: - always_ask - ask_if_missing - extract type: type: string enum: - boolean - date - multiselect - number - select - text fieldId: type: string label: type: string required: - required - key - mode - type - fieldId - label instructions: type: - string - 'null' chatWidget: type: boolean greeting: type: - string - 'null' botIdentifier: type: - string - 'null' contactInformation: type: - string - 'null' required: - object - name - createdAt - id - status - updatedAt - signature - description - model - autoReply - knowledgeSetNames - usePastTickets - teamName - suggestedActions - collectedFields - instructions - chatWidget - greeting - botIdentifier - contactInformation Error: type: object description: Every error response, whatever the status (app/exceptions/handler.ts). properties: error: type: object properties: type: type: string enum: - api_error - authentication_error - invalid_request_error - permission_error - rate_limit_error code: type: string description: Stable, machine-readable error code. message: type: string requestId: type: string fields: type: array description: Per-field problems, on validation errors. items: type: object properties: field: type: string code: type: string message: type: string required: - field - code - message required: - type - code - message - requestId required: - error responses: Unauthenticated: description: Missing or invalid credentials (`authentication_error`). content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: The credential may not do this (`permission_error`). content: application/json: schema: $ref: '#/components/schemas/Error' ValidationFailed: description: The request has invalid fields (`validation_failed`). content: application/json: schema: $ref: '#/components/schemas/Error' TooManyRequests: description: Rate limited (`too_many_requests`). headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' Retry-After: $ref: '#/components/headers/Retry-After' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/Error' Error: description: Any other error, in the same envelope. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: accessToken: type: http scheme: bearer bearerFormat: oat_… description: An access token, bound to one account. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.