openapi: 3.1.0
info:
  title: Credal API
  version: 1.0.0
  description: >-
    DO NOT manually edit this spec. It is auto-generated from the app repo
    (app/api/v1/openapi). Always use the latest export.
servers:
  - url: https://app.credal.ai/api/v1
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth
  schemas: {}
  parameters: {}
paths:
  /agents/sendMessage:
    post:
      x-fern-sdk-group-name: agents
      x-fern-sdk-method-name: sendMessage
      summary: Send a message to an agent
      description: >-
        Sends a message to a deployed agent and returns a job ID that can be
        used to poll for the response. Requires the `api:agent:message:*` scope.
      security:
        - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                agentId:
                  type: string
                  format: uuid
                conversation:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - new
                        dataInputVariableSelections:
                          type:
                            - object
                            - 'null'
                          additionalProperties:
                            type: array
                            items:
                              type: string
                      required:
                        - type
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - existing
                        conversationId:
                          type: string
                          format: uuid
                      required:
                        - type
                        - conversationId
                message:
                  type: string
              required:
                - agentId
                - conversation
                - message
              additionalProperties: false
              example:
                agentId: cc3fd192-ea62-11f0-99fd-03d6b2458fff
                message: What documents do we have about Q4 planning?
                conversation:
                  type: new
                  dataInputVariableSelections: null
      responses:
        '200':
          description: Message sent successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  jobId:
                    type: string
                required:
                  - jobId
                example:
                  jobId: d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '500':
          description: Internal server error
  /agents/fetchAgentResponse:
    get:
      x-fern-sdk-group-name: agents
      x-fern-sdk-method-name: fetchResponse
      summary: Fetch the status of an agent response
      description: >-
        Polls for the status and result of a previously sent agent message using
        the job ID returned by sendMessage. Requires the `api:agent:message:*`
        scope.
      security:
        - BearerAuth: []
      parameters:
        - schema:
            type: string
          required: true
          name: jobId
          in: query
      responses:
        '200':
          description: Agent response status
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - RUNNING
                    required:
                      - status
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - COMPLETED
                      result:
                        type: object
                        properties:
                          agentResponseText:
                            type: string
                        required:
                          - agentResponseText
                    required:
                      - status
                      - result
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - FAILED
                      errorMessage:
                        type: string
                    required:
                      - status
                      - errorMessage
                example:
                  status: COMPLETED
                  result:
                    agentResponseText: Here are the Q4 planning documents I found...
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Job not found
        '500':
          description: Internal server error
webhooks: {}