Credal

Credal API

Credal API as documented publicly: 11 operations. Contract generated from the documentation by API Evangelist (2026-10-20); not the provider's own document.

GitHub OpenAPI

Operations 11

DELETE /api Delete Copilot #
POST /api Export copilot configurations for backup or migration purposes. #
GET /api/audit-logs/organization GET /api/audit-logs/organization #
POST /api/oauth/token POST /api/oauth/token #
GET /api/platform-audit-logs/export GET /api/platform-audit-logs/export #
GET /api/v0/audit-logs/usage-analytics GET /api/v0/audit-logs/usage-analytics #
POST /api/v0/catalog/uploadFile POST /api/v0/catalog/uploadFile #
POST /api/v0/copilots/sendMessage POST /api/v0/copilots/sendMessage #
POST /api/v1 Sends a message to a deployed agent and returns a job ID that can be used to poll for the response. #
GET /v1/agents/fetchAgentResponse Send Message #
POST /v1/agents/sendMessage Send Message #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/credal/openapi/_ae-authored/credal-openapi-generated.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/credal/json-schema/credal-post-api-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/credal/json-schema/credal-post-v1-agents-sendmessage-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/credal/json-schema/credal-post-api-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/credal/json-schema/credal-post-api-v1-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/credal/json-schema/credal-post-api-v0-copilots-sendmessage-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/credal/json-schema/credal-post-api-v1-response-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/credal/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/credal:credal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

credal-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Credal API
  version: '2026-10-20'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-20: 11 operation(s) read from 40 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Credal has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 6
    documentation: 5
    pages-with-code: 6
    pages-read: 40
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-20'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.credal.ai/user-guide/platform/administration/audit-logs-api
  - https://docs.credal.ai/api-reference/service-accounts
  - https://docs.credal.ai/api-reference/v-1/o-auth-setup
  - https://docs.credal.ai/api-reference/v-1/o-auth-setup.md
  - https://docs.credal.ai/api-reference/v-0/service-accounts.md
  - https://docs.credal.ai/api-reference/api-reference/users/metadata
  - https://docs.credal.ai/api-reference/api-reference/copilots/export
  - https://docs.credal.ai/api-reference/api-reference/copilots/send-message
  - https://docs.credal.ai/api-reference/api-reference/copilots/create-copilot
  - https://docs.credal.ai/api-reference/api-reference/copilots/delete-copilot
  - https://docs.credal.ai/api-reference/api-reference/copilots/stream-message
  - https://docs.credal.ai/api-reference/v-1/api-reference/agents/send-message
  - https://docs.credal.ai/api-reference/api-reference/document-catalog/metadata
  - https://docs.credal.ai/api-reference/v-1/api-reference/agents/fetch-response
  - https://docs.credal.ai/api-reference/api-reference/copilots/create-conversation
  - https://docs.credal.ai/api-reference/api-reference/document-catalog/upload-file
  - https://docs.credal.ai/api-reference/api-reference/copilots/update-configuration
  - https://docs.credal.ai/api-reference/api-reference/copilots/provide-message-feedback
  - https://docs.credal.ai/api-reference/api-reference/search/search-document-collection
  - https://docs.credal.ai/api-reference/api-reference/copilots/add-collection-to-copilot
  - https://docs.credal.ai/api-reference/api-reference/document-catalog/sync-source-by-url
  - https://docs.credal.ai/api-reference/api-reference/document-collections/create-collection
  - https://docs.credal.ai/api-reference/api-reference/document-collections/delete-collection
  - https://docs.credal.ai/api-reference/api-reference/copilots/remove-collection-from-copilot
  - https://docs.credal.ai/api-reference/api-reference/document-catalog/upload-document-contents
  - https://docs.credal.ai/api-reference/api-reference/document-collections/add-documents-to-collection
  - https://docs.credal.ai/api-reference/api-reference/document-collections/create-mongo-collection-sync
  - https://docs.credal.ai/api-reference/api-reference/document-collections/list-documents-in-collection
  - https://docs.credal.ai/api-reference/api-reference/document-collections/update-mongo-collection-sync
  - https://docs.credal.ai/api-reference/api-reference/document-collections/remove-documents-from-collection
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/create-copilot
  - https://docs.credal.ai/api-reference/v-0/service-accounts
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/create-conversation
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/provide-message-feedback
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/add-collection-to-copilot
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/remove-collection-from-copilot
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/update-configuration
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/delete-copilot
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/export
  - https://docs.credal.ai/api-reference/v-0/api-reference/copilots/send-message
servers:
- url: https://api.credal.ai
paths:
  /api:
    delete:
      operationId: delete_api
      tags:
      - Api
      summary: Delete Copilot
      description: This endpoint expects an object with an id (UUID) and returns an object containing copilotId (UUID).
      x-source: https://docs.credal.ai/api-reference/api-reference/copilots/delete-copilot
      parameters:
      - name: id
        in: query
        required: true
        schema:
          type: string
        description: Copilot ID
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api
      tags:
      - Api
      summary: Export copilot configurations for backup or migration purposes.
      description: Returns all deployed copilots with their full configuration including model settings, tools, and deployment details. Optional
        date filters can be applied to narrow down results.
      x-source: https://docs.credal.ai/api-reference/api-reference/copilots/export
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiResponse'
      x-evidence:
        kind: documentation
  /api/audit-logs/organization:
    get:
      operationId: get_api_audit_logs_organization
      tags:
      - Api
      summary: GET /api/audit-logs/organization
      x-source: https://docs.credal.ai/user-guide/platform/administration/audit-logs-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl ' https://api.credal.ai/api/audit-logs/organization ' \\ --data ' {\"limit\":1000, \"startDate\":\"2024-05-01\", \"endDate\"\
          :\"2024-05-10\"} ' \\ -H ' content-type: application/json ' \\ -H ' Authorization: Bearer CREDAL_TOKEN ' \n Audit logs are ordered by\
          \ datetime, with the most recent logs first, and the oldest last. \n Pagination \n To paginate past the first n rows, take the latest\
          \ or oldest datetime fr"
  /api/oauth/token:
    post:
      operationId: post_api_oauth_token
      tags:
      - Api
      summary: POST /api/oauth/token
      x-source: https://docs.credal.ai/api-reference/v-1/o-auth-setup
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiOauthTokenResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Python TypeScript curl -X POST https://app.credal.ai/api/oauth/token \\ -H \" Content-Type: application/x-www-form-urlencoded\
          \ \" \\ -d \" grant_type=authorization_code \" \\ -d \" code=<authorization_code> \" \\ -d \" client_id=<your_client_id> \" \\ -d \"\
          \ client_secret=<your_client_secret> \" \\ -d \" redirect_uri=<your_redirect_uri> \" \\ -d \" code_verifier=<code_verifier> \" \n The\
          \ response contains the tokens"
  /api/platform-audit-logs/export:
    get:
      operationId: get_api_platform_audit_logs_export
      tags:
      - Api
      summary: GET /api/platform-audit-logs/export
      x-source: https://docs.credal.ai/user-guide/platform/administration/audit-logs-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl ' https://api.credal.ai/api/platform-audit-logs/export ' \\ --data ' {\"limit\":1000} ' \\ -H ' content-type: application/json\
          \ ' \\ -H ' Authorization: Bearer CREDAL_TOKEN ' \n AI Usage Analytics Logs \n AI Usage Analytics logs can be exported with any key\
          \ that has the following Scope: \n ai-usage-analytics-log.export \n This scope must be approved by an admin, but a Developer must create\
          \ the token, a"
  /api/v0/audit-logs/usage-analytics:
    get:
      operationId: get_api_v0_audit_logs_usage_analytics
      tags:
      - Api
      summary: GET /api/v0/audit-logs/usage-analytics
      x-source: https://docs.credal.ai/user-guide/platform/administration/audit-logs-api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl ' https://api.credal.ai/api/v0/audit-logs/usage-analytics ' \\ --data ' {\"limit\":1000,\"offset\":0, \"startDate\":\"\
          2024-05-01\", \"endDate\":\"2024-05-10\"} ' \\ -H ' content-type: application/json ' \\ -H ' Authorization: Bearer CREDAL_TOKEN ' \n\
          \ Usage analytics logs are filtered by datetime, with the most recent logs first, and the oldest last. Was this page helpful? Yes No\
          \ Previous Data Warehouse Integ"
  /api/v0/catalog/uploadFile:
    post:
      operationId: post_api_v0_catalog_uploadFile
      tags:
      - Api
      summary: POST /api/v0/catalog/uploadFile
      x-source: https://docs.credal.ai/api-reference/service-accounts
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV0CatalogUploadfileResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Python TypeScript curl -X POST https://app.credal.ai/api/v0/catalog/uploadFile \\ -H \" Authorization: Bearer $CREDAL_SERVICE_ACCOUNT_TOKEN\
          \ \" \\ -F \" file=@quarterly-report.pdf \" \\ -F \" documentExternalId=quarterly-report-2026-q2 \" \\ -F \" documentName=Quarterly\
          \ Report Q2 2026 \" \\ -F \" collectionId=5b2c9d3e-1f4a-4b6c-8d9e-0a7f5b2c9d3e \" \n A successful response returns the Credal document\
          \ ID: \n { "
  /api/v0/copilots/sendMessage:
    post:
      operationId: post_api_v0_copilots_sendMessage
      tags:
      - Api
      summary: POST /api/v0/copilots/sendMessage
      x-source: https://docs.credal.ai/api-reference/service-accounts
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV0CopilotsSendmessageResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl Python TypeScript curl -X POST https://app.credal.ai/api/v0/copilots/sendMessage \\ -H \" Authorization: Bearer $CREDAL_SERVICE_ACCOUNT_TOKEN\
          \ \" \\ -H \" Content-Type: application/json \" \\ -d ' { \"agentId\": \"3a1b8c2d-0e4f-4a6b-9c8d-7e5f3a1b8c2d\", \"message\": \"Summarize\
          \ open support tickets from this week.\" } ' \n A successful response looks like: \n { \" sendChatResult \" : { \" type \" : \" ai_response_r"
  /api/v1:
    post:
      operationId: post_api_v1
      tags:
      - Api
      summary: Sends a message to a deployed agent and returns a job ID that can be used to poll for the response.
      x-source: https://docs.credal.ai/api-reference/v-1/api-reference/agents/send-message
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1Request'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1Response'
      x-evidence:
        kind: documentation
  /v1/agents/fetchAgentResponse:
    get:
      operationId: get_v1_agents_fetchAgentResponse
      tags:
      - Agents
      summary: Send Message
      x-source: https://docs.credal.ai/api-reference/api-reference/copilots/send-message
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1AgentsFetchagentresponseResponse'
      x-evidence:
        kind: documentation
  /v1/agents/sendMessage:
    post:
      operationId: post_v1_agents_sendMessage
      tags:
      - Agents
      summary: Send Message
      x-source: https://docs.credal.ai/api-reference/api-reference/copilots/send-message
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1AgentsSendmessageRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1AgentsSendmessageResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    DeleteApiResponse:
      type: object
      properties:
        copilotId:
          type: string
          description: Copilot ID
    PostApiRequest:
      type: object
      properties:
        agentCreatedFrom:
          type: string
          description: Filter copilots created on or after this datetime (ISO 8601 format).
        agentCreatedTo:
          type: string
          description: Filter copilots created before or on this datetime (ISO 8601 format).
        versionCreatedFrom:
          type: string
          description: Filter copilot versions created on or after this datetime (ISO 8601 format).
        versionCreatedTo:
          type: string
          description: Filter copilot versions created before or on this datetime (ISO 8601 format).
        limit:
          type: integer
          description: Maximum number of copilots to return. Must be a positive integer with a maximum value of 1000. Defaults to 100.
        cursor:
          type: string
          description: Cursor for pagination. Use the cursor returned in the previous response to fetch the next page of results.
    PostApiResponse:
      type: object
      properties:
        data:
          type: array
          description: List of exported copilots matching the query filters.
        hasMore:
          type: boolean
          description: Indicates whether there are more results available for pagination.
        nextCursor:
          type: string
          description: Optional Cursor to use for fetching the next page of results. This is a UUID string.
    PostApiOauthTokenResponse:
      type: object
      properties:
        ' access_token ':
          type: string
        ' token_type ':
          type: string
        ' expires_in ':
          type: integer
        ' refresh_token ':
          type: string
    PostApiV0CatalogUploadfileResponse:
      type: object
      properties:
        ' documentId ':
          type: string
    PostApiV0CopilotsSendmessageResponse:
      type: object
      properties:
        ' sendChatResult ':
          type: object
          properties:
            ' type ':
              type: string
            ' conversationId ':
              type: string
            ' response ':
              type: object
              properties:
                ' message ':
                  type: string
    PostApiV1Request:
      type: object
      properties:
        agentId:
          type: string
          description: 'Agent identifier, format: uuid'
        conversation:
          type: object
          description: Conversation object
        message:
          type: string
          description: Message to send
      required:
      - agentId
      - conversation
      - message
    PostApiV1Response:
      type: object
      properties:
        jobId:
          type: string
          description: Job identifier for the request
        conversationId:
          type: string
          description: 'Conversation identifier, format: uuid'
    GetV1AgentsFetchagentresponseResponse:
      type: object
      properties:
        sendChatResult:
          type: object
          description: Result object containing the AI response.
    PostV1AgentsSendmessageRequest:
      type: object
      properties:
        agentId:
          type: string
          description: Credal-generated Agent ID to specify which agent to route the request to.
        message:
          type: string
          description: The message you want to send to your agent.
        userEmail:
          type: string
          description: The user profile you want to use when sending the message.
        conversationId:
          type: string
          description: Credal-generated conversation ID for sending follow up messages.
        inputVariables:
          type: array
          description: Beta Optional input variables to be used in the message.
      required:
      - agentId
      - message
      - userEmail
    PostV1AgentsSendmessageResponse:
      type: object
      properties:
        sendChatResult:
          type: object
          description: Result object containing the AI response.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Agents
- name: Api