AdvisorPPC Chat API

The chat API from AdvisorPPC — 11 operation(s) for chat.

Operations 13

POST /api/chat/attachments Initiate Chat Attachment #
POST /api/chat Chat #
POST /api/chat/sessions/{thread_id}/agent-runs Start Chat Agent Run #
GET /api/chat/sessions/{thread_id}/agent-runs List Chat Agent Runs #
POST /api/chat/mcp-app/call-tool Call Tool #
POST /api/chat/mcp-app/resource Read Resource #
GET /api/chat/runs/by-request/{client_request_id} By Request #
POST /api/chat/runs/by-request/{client_request_id}/cancel Cancel By Request #
GET /api/chat/runs/{run_id}/events Events #
POST /api/chat/runs/{run_id}/cancel Cancel #
GET /api/chat/sessions List Sessions #
GET /api/chat/sessions/{thread_id} Get Session #
DELETE /api/chat/sessions/{thread_id} Delete Session #

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/advisorppc-com:advisorppc-com-chat-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

advisorppc-com-chat-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AdvisorPPC Chat API
  version: 0.1.0
tags:
- name: Chat
paths:
  /api/chat/attachments:
    post:
      tags:
      - Chat
      summary: Initiate Chat Attachment
      description: 'Reserved upload contract, disabled until its security rail is real.


        Parsing still enforces the public filename, MIME, size, and digest bounds.

        No metadata row is created and no client bytes are accepted.'
      operationId: initiate_chat_attachment_api_chat_attachments_post
      security:
      - HTTPBearer: []
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatAttachmentUploadIn'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAttachmentUploadOut'
        '503':
          description: Upload initiation is disabled until durable storage and content inspection are configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAttachmentErrorOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat:
    post:
      tags:
      - Chat
      summary: Chat
      operationId: chat_api_chat_post
      security:
      - HTTPBearer: []
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '404':
          description: Attachment not found in the actor's tenant scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAttachmentErrorOut'
        '409':
          description: Attachment metadata is not ready.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAttachmentErrorOut'
        '410':
          description: Attachment metadata has expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAttachmentErrorOut'
        '413':
          description: Combined attachment size exceeds the turn limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAttachmentErrorOut'
        '503':
          description: Chat or attachment delivery is not configured.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAttachmentErrorOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/sessions/{thread_id}/agent-runs:
    post:
      tags:
      - Chat
      summary: Start Chat Agent Run
      operationId: start_chat_agent_run_api_chat_sessions__thread_id__agent_runs_post
      security:
      - HTTPBearer: []
      parameters:
      - name: thread_id
        in: path
        required: true
        schema:
          type: integer
          title: Thread Id
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartChatAgentRunIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAgentRunOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Chat
      summary: List Chat Agent Runs
      operationId: list_chat_agent_runs_api_chat_sessions__thread_id__agent_runs_get
      security:
      - HTTPBearer: []
      parameters:
      - name: thread_id
        in: path
        required: true
        schema:
          type: integer
          title: Thread Id
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatAgentRunListOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/mcp-app/call-tool:
    post:
      tags:
      - Chat
      summary: Call Tool
      description: Proxy one view ``tools/call``; only chat's read-only tools pass.
      operationId: call_tool_api_chat_mcp_app_call_tool_post
      security:
      - HTTPBearer: []
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/McpAppCallIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Call Tool Api Chat Mcp App Call Tool Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/mcp-app/resource:
    post:
      tags:
      - Chat
      summary: Read Resource
      description: The HTML document behind one ``ui://`` view.
      operationId: read_resource_api_chat_mcp_app_resource_post
      security:
      - HTTPBearer: []
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/McpAppResourceIn'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                title: Response Read Resource Api Chat Mcp App Resource Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/runs/by-request/{client_request_id}:
    get:
      tags:
      - Chat
      summary: By Request
      operationId: by_request_api_chat_runs_by_request__client_request_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: client_request_id
        in: path
        required: true
        schema:
          type: string
          title: Client Request Id
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response By Request Api Chat Runs By Request  Client Request Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/runs/by-request/{client_request_id}/cancel:
    post:
      tags:
      - Chat
      summary: Cancel By Request
      operationId: cancel_by_request_api_chat_runs_by_request__client_request_id__cancel_post
      security:
      - HTTPBearer: []
      parameters:
      - name: client_request_id
        in: path
        required: true
        schema:
          type: string
          title: Client Request Id
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Cancel By Request Api Chat Runs By Request  Client Request Id  Cancel Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/runs/{run_id}/events:
    get:
      tags:
      - Chat
      summary: Events
      operationId: events_api_chat_runs__run_id__events_get
      security:
      - HTTPBearer: []
      parameters:
      - name: run_id
        in: path
        required: true
        schema:
          type: integer
          title: Run Id
      - name: after
        in: query
        required: false
        schema:
          type: integer
          maximum: 9007199254740991
          minimum: 0
          default: 0
          title: After
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/runs/{run_id}/cancel:
    post:
      tags:
      - Chat
      summary: Cancel
      operationId: cancel_api_chat_runs__run_id__cancel_post
      security:
      - HTTPBearer: []
      parameters:
      - name: run_id
        in: path
        required: true
        schema:
          type: integer
          title: Run Id
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Cancel Api Chat Runs  Run Id  Cancel Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/sessions:
    get:
      tags:
      - Chat
      summary: List Sessions
      operationId: list_sessions_api_chat_sessions_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response List Sessions Api Chat Sessions Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/chat/sessions/{thread_id}:
    get:
      tags:
      - Chat
      summary: Get Session
      operationId: get_session_api_chat_sessions__thread_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: thread_id
        in: path
        required: true
        schema:
          type: integer
          title: Thread Id
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Session Api Chat Sessions  Thread Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Chat
      summary: Delete Session
      operationId: delete_session_api_chat_sessions__thread_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: thread_id
        in: path
        required: true
        schema:
          type: integer
          title: Thread Id
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: X-Tenant-Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    app__chat_continuation__AnswerIn:
      properties:
        question_id:
          type: integer
          exclusiveMinimum: 0.0
          title: Question Id
        version:
          type: integer
          minimum: 1.0
          title: Version
        continuation_token:
          type: string
          maxLength: 128
          minLength: 32
          pattern: ^[A-Za-z0-9_-]+$
          title: Continuation Token
        option_id:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          title: Option Id
        free_text:
          anyOf:
          - type: string
            maxLength: 1000
          - type: 'null'
          title: Free Text
      additionalProperties: false
      type: object
      required:
      - question_id
      - version
      - continuation_token
      title: AnswerIn
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ChatAgentRunListOut:
      properties:
        thread_id:
          type: integer
          title: Thread Id
        runs:
          items:
            $ref: '#/components/schemas/ChatAgentRunOut'
          type: array
          title: Runs
      type: object
      required:
      - thread_id
      - runs
      title: ChatAgentRunListOut
    ChatAgentRunOut:
      properties:
        id:
          type: integer
          title: Id
        thread_id:
          type: integer
          title: Thread Id
        instance_id:
          type: integer
          title: Instance Id
        definition_key:
          type: string
          title: Definition Key
        agent_name:
          type: string
          title: Agent Name
        display_name:
          type: string
          title: Display Name
        status:
          type: string
          title: Status
        summary:
          anyOf:
          - type: string
          - type: 'null'
          title: Summary
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
        finished_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished At
      type: object
      required:
      - id
      - thread_id
      - instance_id
      - definition_key
      - agent_name
      - display_name
      - status
      - summary
      - error
      - created_at
      - updated_at
      - started_at
      - finished_at
      title: ChatAgentRunOut
    ChatAttachmentUploadIn:
      properties:
        fileName:
          type: string
          maxLength: 255
          minLength: 1
          title: Filename
        mimeType:
          type: string
          maxLength: 100
          minLength: 1
          title: Mimetype
        byteSize:
          type: integer
          maximum: 10485760.0
          minimum: 1.0
          title: Bytesize
        sha256:
          type: string
          maxLength: 64
          minLength: 64
          pattern: ^[0-9a-f]{64}$
          title: Sha256
      additionalProperties: false
      type: object
      required:
      - fileName
      - mimeType
      - byteSize
      - sha256
      title: ChatAttachmentUploadIn
      description: 'Future upload-initiation shape.


        The endpoint is intentionally unavailable until durable object storage and

        content inspection are configured. ``sha256`` is only a client declaration;

        a future ingestion worker must calculate and store the verified digest.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChatAttachmentRefIn:
      properties:
        assetId:
          type: string
          maxLength: 32
          minLength: 32
          pattern: ^[0-9a-f]{32}$
          title: Assetid
      additionalProperties: false
      type: object
      required:
      - assetId
      title: ChatAttachmentRefIn
      description: Opaque reference only. File metadata is always loaded server-side.
    ChatAttachmentErrorOut:
      properties:
        detail:
          type: string
          title: Detail
      additionalProperties: false
      type: object
      required:
      - detail
      title: ChatAttachmentErrorOut
    McpAppResourceIn:
      properties:
        conversationId:
          type: integer
          exclusiveMinimum: 0.0
          title: Conversationid
        server:
          type: string
          maxLength: 40
          minLength: 1
          title: Server
        uri:
          type: string
          maxLength: 200
          minLength: 1
          title: Uri
      type: object
      required:
      - conversationId
      - server
      - uri
      title: McpAppResourceIn
    StartChatAgentRunIn:
      properties:
        instance_id:
          type: integer
          title: Instance Id
      type: object
      required:
      - instance_id
      title: StartChatAgentRunIn
    ChatMessageIn:
      properties:
        role:
          type: string
          enum:
          - user
          - assistant
          title: Role
        content:
          type: string
          maxLength: 20000
          minLength: 1
          title: Content
      additionalProperties: false
      type: object
      required:
      - role
      - content
      title: ChatMessageIn
    ChatIn:
      properties:
        resumable:
          type: boolean
          title: Resumable
          default: false
        question_cards:
          type: boolean
          title: Question Cards
          default: false
        continuation:
          anyOf:
          - $ref: '#/components/schemas/app__chat_continuation__AnswerIn'
          - type: 'null'
        messages:
          items:
            $ref: '#/components/schemas/ChatMessageIn'
          type: array
          maxItems: 50
          minItems: 1
          title: Messages
        attachments:
          items:
            $ref: '#/components/schemas/ChatAttachmentRefIn'
          type: array
          maxItems: 5
          title: Attachments
        conversationId:
          anyOf:
          - type: integer
          - type: 'null'
          title: Conversationid
        clientRequestId:
          anyOf:
          - type: string
            maxLength: 64
            minLength: 1
          - type: 'null'
          title: Clientrequestid
        model:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Model
        effort:
          anyOf:
          - type: string
            enum:
            - none
            - low
            - medium
            - high
            - xhigh
            - max
            maxLength: 16
          - type: 'null'
          title: Effort
        writeMode:
          type: string
          enum:
          - manual
          - accept
          - plan
          - auto
          title: Writemode
          default: manual
        agentInstanceId:
          anyOf:
          - type: integer
            exclusiveMinimum: 0.0
          - type: 'null'
          title: Agentinstanceid
        connector:
          anyOf:
          - type: string
            pattern: ^[a-z][a-z0-9-]{0,39}$
          - type: 'null'
          title: Connector
        timeZone:
          anyOf:
          - type: string
            maxLength: 64
            pattern: ^[A-Za-z0-9_+\-/]{1,64}$
          - type: 'null'
          title: Timezone
      additionalProperties: false
      type: object
      required:
      - messages
      title: ChatIn
    ChatAttachmentUploadOut:
      properties:
        assetId:
          type: string
          maxLength: 32
          minLength: 32
          pattern: ^[0-9a-f]{32}$
          title: Assetid
      additionalProperties: false
      type: object
      required:
      - assetId
      title: ChatAttachmentUploadOut
      description: Reserved success shape for a future enabled upload-initiation rail.
    McpAppCallIn:
      properties:
        conversationId:
          type: integer
          exclusiveMinimum: 0.0
          title: Conversationid
        server:
          type: string
          maxLength: 40
          minLength: 1
          title: Server
        name:
          type: string
          maxLength: 64
          minLength: 1
          title: Name
        arguments:
          additionalProperties: true
          type: object
          title: Arguments
      type: object
      required:
      - conversationId
      - server
      - name
      title: McpAppCallIn
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer