> ## Documentation Index > Fetch the complete documentation index at: https://chatbotx.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Discover workspace capabilities > Returns compact (id + name, plus a couple of decisive fields) lists of the workspace entities an agent needs to reference by id — inboxes, WhatsApp templates, custom/bot fields, tags, AI agents, sequences, and flows — plus the flow-spec DSL's step types and valid wait units/channels. Bot fields are reference data only; they cannot be used as a branch condition's `field` (only custom fields and built-in contact fields can). Use `include` (comma-separated) to narrow the response; omit it for the default set an agent needs to build a flow. Call this before `flows.create`/`flows.publish`/`flows.updateDraft`/`flows.validate` so names in a flow spec resolve to real ids instead of guesses. ## OpenAPI ````yaml /api-reference/platform-api.json get /v1/capabilities openapi: 3.1.1 info: title: ChatbotX version: 0.0.1 servers: - url: https://app.chatbotx.io/api security: - bearerAuth: [] - developerAccessToken: [] - tokenInSearchParams: [] paths: /v1/capabilities: get: tags: - Capabilities summary: Discover workspace capabilities description: >- Returns compact (id + name, plus a couple of decisive fields) lists of the workspace entities an agent needs to reference by id — inboxes, WhatsApp templates, custom/bot fields, tags, AI agents, sequences, and flows — plus the flow-spec DSL's step types and valid wait units/channels. Bot fields are reference data only; they cannot be used as a branch condition's `field` (only custom fields and built-in contact fields can). Use `include` (comma-separated) to narrow the response; omit it for the default set an agent needs to build a flow. Call this before `flows.create`/`flows.publish`/`flows.updateDraft`/`flows.validate` so names in a flow spec resolve to real ids instead of guesses. operationId: capabilities.get parameters: - name: include in: query schema: type: array items: enum: - inboxes - templates - customFields - botFields - tags - aiAgents - sequences - flows - flowSpec type: string description: >- Comma-separated list of capability categories to include. Omit to get the default set. style: deepObject explode: true allowEmptyValue: true allowReserved: true responses: '200': description: OK content: application/json: schema: type: object properties: inboxes: type: array items: type: object properties: id: type: string description: Inbox ID. name: type: string description: Inbox name. channel: type: string description: Inbox channel. required: - id - name - channel description: An inbox available in the workspace. description: Inboxes available in the workspace. templates: type: array items: type: object properties: id: type: string description: WhatsApp message template ID. name: type: string description: WhatsApp message template name. language: type: string description: WhatsApp message template language. status: type: string description: >- WhatsApp message template status. Actual values are APPROVED, PENDING, or REJECTED. params: type: object properties: header: type: array items: type: object properties: type: enum: - text - image - video - document - location type: string text: type: string parameter_name: type: string image: type: object properties: link: type: string required: - link video: type: object properties: link: type: string required: - link document: type: object properties: link: type: string required: - link location: type: object properties: latitude: type: string longitude: type: string name: type: string address: type: string required: - type body: type: array items: type: object properties: type: const: text text: type: string parameter_name: type: string required: - text button: {} carousel: type: array items: type: object properties: card_index: type: number header: type: array items: type: object properties: type: enum: - image - video type: string image: type: object properties: link: type: string required: - link video: type: object properties: link: type: string required: - link required: - type body: type: array items: type: object properties: type: const: text text: type: string required: - text button: {} required: - card_index limited_time_offer: type: object properties: expiration_time_ms: type: number required: - expiration_time_ms description: >- Parameters required to send the WhatsApp message template. required: - id - name - language - status - params description: A WhatsApp message template available in the workspace. description: WhatsApp message templates available in the workspace. customFields: type: array items: type: object properties: id: type: string description: Field ID. name: type: string description: Field name. type: type: string description: Field value type. required: - id - name - type description: A custom or bot field available in the workspace. description: Custom fields available in the workspace. botFields: type: array items: type: object properties: id: type: string description: Field ID. name: type: string description: Field name. type: type: string description: Field value type. required: - id - name - type description: A custom or bot field available in the workspace. description: Bot fields available as reference data only. tags: type: array items: type: object properties: id: type: string description: Entity ID. name: type: string description: Entity name. required: - id - name description: A named workspace entity. description: Tags available in the workspace. aiAgents: type: array items: type: object properties: id: type: string description: Entity ID. name: type: string description: Entity name. required: - id - name description: A named workspace entity. description: AI agents available in the workspace. sequences: type: array items: type: object properties: id: type: string description: Entity ID. name: type: string description: Entity name. required: - id - name description: A named workspace entity. description: Sequences available in the workspace. flows: type: array items: type: object properties: id: type: string description: Entity ID. name: type: string description: Entity name. required: - id - name description: A named workspace entity. description: Flows available in the workspace. flowSpec: type: object properties: stepTypes: type: array items: type: object properties: type: type: string description: Flow-spec step type. description: type: string description: How to use this flow-spec step type. required: - type - description description: >- A flow-spec step type supported by the flow authoring DSL. description: Supported flow-spec step types. waitUnits: type: array items: type: string description: Supported wait-step delay units. channels: type: array items: type: string description: Supported flow channels. required: - stepTypes - waitUnits - channels description: Reference data for authoring a flow spec. description: Workspace capabilities available to an agent. '400': description: '400' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: businessError status: const: 400 message: type: string default: An error occurred while processing your request data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '401': description: '401' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: UNAUTHORIZED status: const: 401 message: type: string default: Authentication required data: {} required: - defined - code - status - message - type: object properties: defined: const: true code: const: INVALID_CHATBOT_TOKEN status: const: 401 message: type: string default: Invalid or missing workspace API token data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '403': description: '403' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: FORBIDDEN status: const: 403 message: type: string default: You do not have permission to perform this action data: {} required: - defined - code - status - message - type: object properties: defined: const: true code: const: trialExpired status: const: 403 message: type: string default: Trial expired data: {} required: - defined - code - status - message - type: object properties: defined: const: true code: const: macLimitReached status: const: 403 message: type: string default: Monthly active contact limit reached data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '422': description: '422' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: invalidRequestData status: const: 422 message: type: string default: Input validation failed data: type: object properties: issues: type: array items: type: object properties: message: type: string path: type: array items: anyOf: - type: string - type: number - type: object properties: key: anyOf: - type: string - type: number required: - key additionalProperties: {} required: - message additionalProperties: {} required: - issues additionalProperties: {} required: - defined - code - status - message - data - type: object properties: defined: const: true code: const: validation status: const: 422 message: type: string default: Validation error data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '429': description: '429' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: tooManyRequests status: const: 429 message: type: string default: Too many requests data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' '500': description: '500' content: application/json: schema: oneOf: - type: object properties: defined: const: true code: const: INTERNAL_SERVER_ERROR status: const: 500 message: type: string default: An unexpected error occurred data: {} required: - defined - code - status - message - $ref: '#/components/schemas/UndefinedError' components: schemas: UndefinedError: type: object properties: defined: const: false code: type: string status: type: number message: type: string data: {} required: - defined - code - status - message securitySchemes: bearerAuth: type: http scheme: bearer developerAccessToken: type: http scheme: bearer tokenInSearchParams: type: apiKey in: query name: token ````