Arthur AI Agents V1 API

openapi: 3.1.0
info:
  title: Arthur Scope Agents V1 API
  version: 0.1.0
tags:
- name: Agents V1
paths:
  /api/v1/organization/unregistered_agents:
    get:
      tags:
      - Agents V1
      summary: List Organization Unregistered Agents
      description: 'Lists all unregistered agents across every workspace in the organization. Gate-only: unregistered agents have no model to evaluate, so the org permission gate is the entire access boundary. Requires organization_list_unregistered_agents permission.'
      operationId: list_unregistered_agents_for_organization
      security:
      - OAuth2AuthorizationCode:
        - organization_list_unregistered_agents
      parameters:
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/AgentSort'
          description: The field to sort the agents by.
          default: created_at
        description: The field to sort the agents by.
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: The order to sort the agents by.
          default: desc
        description: The order to sort the agents by.
      - name: name_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter agents by name.
          title: Name Filter
        description: Filter agents by name.
      - name: agent_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter agents by agent IDs.
          title: Agent Ids
        description: Filter agents by agent IDs.
      - name: task_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter agents by task IDs.
          title: Task Ids
        description: Filter agents by task IDs.
      - name: sub_agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these sub-agent names.
          title: Sub Agent Names
        description: Filter agents that use any of these sub-agent names.
      - name: tool_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these tool names.
          title: Tool Names
        description: Filter agents that use any of these tool names.
      - name: llm_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these llm model names.
          title: Llm Model Names
        description: Filter agents that use any of these llm model names.
      - name: data_source_urls
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these data source URLs.
          title: Data Source Urls
        description: Filter agents that use any of these data source URLs.
      - name: show_muted
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Filter agents that are muted.
          title: Show Muted
        description: Filter agents that are muted.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_AgentResponse_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/organization/agent_llm_models:
    get:
      tags:
      - Agents V1
      summary: List Organization Agent Llm Models
      description: Lists all registered agent LLM models across every workspace in the organization, filtered to agents whose models the caller can read. Requires organization_list_agent_llm_models permission.
      operationId: list_agent_llm_models_for_organization
      security:
      - OAuth2AuthorizationCode:
        - organization_list_agent_llm_models
      parameters:
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: The order to sort the llm models by.
          default: desc
        description: The order to sort the llm models by.
      - name: name_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter llm models by name.
          title: Name Filter
        description: Filter llm models by name.
      - name: agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter llm models by their associated agent names.
          title: Agent Names
        description: Filter llm models by their associated agent names.
      - name: agent_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter llm models by their associated agent IDs.
          title: Agent Ids
        description: Filter llm models by their associated agent IDs.
      - name: model_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter llm models by any model IDs their associated agents are attached to.
          title: Model Ids
        description: Filter llm models by any model IDs their associated agents are attached to.
      - name: task_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter llm models on their associated task IDs.
          title: Task Ids
        description: Filter llm models on their associated task IDs.
      - name: tool_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter llm models on their associated tool names.
          title: Tool Names
        description: Filter llm models on their associated tool names.
      - name: sub_agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter llm models on agents containing any of these sub-agent names.
          title: Sub Agent Names
        description: Filter llm models on agents containing any of these sub-agent names.
      - name: data_source_urls
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter llm models on agents containing any of these data source URLs.
          title: Data Source Urls
        description: Filter llm models on agents containing any of these data source URLs.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_LLMModel_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/organization/agent_tools:
    get:
      tags:
      - Agents V1
      summary: List Organization Agent Tools
      description: Lists all registered agent tools across every workspace in the organization, filtered to agents whose models the caller can read. Requires organization_list_agent_tools permission.
      operationId: list_agent_tools_for_organization
      security:
      - OAuth2AuthorizationCode:
        - organization_list_agent_tools
      parameters:
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: The order to sort the tools by.
          default: desc
        description: The order to sort the tools by.
      - name: name_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter tools by name.
          title: Name Filter
        description: Filter tools by name.
      - name: agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools by their associated agent names.
          title: Agent Names
        description: Filter tools by their associated agent names.
      - name: agent_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter tools by their associated agent IDs.
          title: Agent Ids
        description: Filter tools by their associated agent IDs.
      - name: model_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter tools by any model IDs their associated agents use.
          title: Model Ids
        description: Filter tools by any model IDs their associated agents use.
      - name: task_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter tools on their associated task IDs.
          title: Task Ids
        description: Filter tools on their associated task IDs.
      - name: sub_agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools on agents containing these sub-agent names.
          title: Sub Agent Names
        description: Filter tools on agents containing these sub-agent names.
      - name: llm_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools on agents containing these llm model names.
          title: Llm Model Names
        description: Filter tools on agents containing these llm model names.
      - name: data_source_urls
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools on agents containing these data source URLs.
          title: Data Source Urls
        description: Filter tools on agents containing these data source URLs.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_Tool_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/agents/registered/{agent_id}:
    get:
      tags:
      - Agents V1
      summary: Get A Registered Agent By Its Id.
      description: Get a single registered agent by ID. Requires agent_read permission.
      operationId: get_registered_agent_by_id
      security:
      - OAuth2AuthorizationCode:
        - agent_read
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/agents/unregistered/{agent_id}:
    patch:
      tags:
      - Agents V1
      summary: Update An Unregistered Agent.
      description: Update an unregistered agent. Requires unregistered_agent_patch permission.
      operationId: update_unregistered_agent
      security:
      - OAuth2AuthorizationCode:
        - unregistered_agent_patch
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Agent Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchUnregisteredAgentRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentResponse'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspaces/{workspace_id}/agents/registered:
    get:
      tags:
      - Agents V1
      summary: List All Agents For A Workspace.
      description: List all agents for a workspace. Requires workspace_list_agents permission.
      operationId: list_agents_for_workspace
      security:
      - OAuth2AuthorizationCode:
        - workspace_list_agents
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/AgentSort'
          description: The field to sort the agents by.
          default: created_at
        description: The field to sort the agents by.
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: The order to sort the agents by.
          default: desc
        description: The order to sort the agents by.
      - name: name_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter agents by name.
          title: Name Filter
        description: Filter agents by name.
      - name: agent_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter agents by agent IDs.
          title: Agent Ids
        description: Filter agents by agent IDs.
      - name: model_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter agents by model IDs.
          title: Model Ids
        description: Filter agents by model IDs.
      - name: task_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter agents by task IDs.
          title: Task Ids
        description: Filter agents by task IDs.
      - name: sub_agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these sub-agent names.
          title: Sub Agent Names
        description: Filter agents that use any of these sub-agent names.
      - name: tool_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these tool names.
          title: Tool Names
        description: Filter agents that use any of these tool names.
      - name: llm_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these llm model names.
          title: Llm Model Names
        description: Filter agents that use any of these llm model names.
      - name: data_source_urls
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these data source URLs.
          title: Data Source Urls
        description: Filter agents that use any of these data source URLs.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_AgentResponse_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspaces/{workspace_id}/agents/unregistered:
    get:
      tags:
      - Agents V1
      summary: List All Unregistered Agents For A Workspace.
      description: List all unregistered agents for a workspace. Requires workspace_list_unregistered_agents permission.
      operationId: list_unregistered_agents_for_workspace
      security:
      - OAuth2AuthorizationCode:
        - workspace_list_unregistered_agents
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/AgentSort'
          description: The field to sort the agents by.
          default: created_at
        description: The field to sort the agents by.
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: The order to sort the agents by.
          default: desc
        description: The order to sort the agents by.
      - name: name_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter agents by name.
          title: Name Filter
        description: Filter agents by name.
      - name: agent_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter agents by agent IDs.
          title: Agent Ids
        description: Filter agents by agent IDs.
      - name: task_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter agents by task IDs.
          title: Task Ids
        description: Filter agents by task IDs.
      - name: sub_agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these sub-agent names.
          title: Sub Agent Names
        description: Filter agents that use any of these sub-agent names.
      - name: tool_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these tool names.
          title: Tool Names
        description: Filter agents that use any of these tool names.
      - name: llm_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these llm model names.
          title: Llm Model Names
        description: Filter agents that use any of these llm model names.
      - name: data_source_urls
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter agents that use any of these data source URLs.
          title: Data Source Urls
        description: Filter agents that use any of these data source URLs.
      - name: show_muted
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Filter agents that are muted.
          title: Show Muted
        description: Filter agents that are muted.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. The max is 1000.
          default: 20
          title: Page Size
        description: The number of records per page. The max is 1000.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceList_AgentResponse_'
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
          description: Internal Server Error
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/workspaces/{workspace_id}/agents/registered/tools:
    get:
      tags:
      - Agents V1
      summary: List All Registered Agent Tools For A Workspace.
      description: List all tools for a workspace. Requires workspace_list_agent_tools permission.
      operationId: list_tools_for_workspace
      security:
      - OAuth2AuthorizationCode:
        - workspace_list_agent_tools
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Workspace Id
      - name: order
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          description: The order to sort the agents by.
          default: desc
        description: The order to sort the agents by.
      - name: name_filter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter tools by name.
          title: Name Filter
        description: Filter tools by name.
      - name: agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools by their associated agent names.
          title: Agent Names
        description: Filter tools by their associated agent names.
      - name: agent_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter tools by their associated agent IDs.
          title: Agent Ids
        description: Filter tools by their associated agent IDs.
      - name: model_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter tools by any model IDs their associated agents are attached to.
          title: Model Ids
        description: Filter tools by any model IDs their associated agents are attached to.
      - name: task_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
              format: uuid
          - type: 'null'
          description: Filter tools on their associated task IDs.
          title: Task Ids
        description: Filter tools on their associated task IDs.
      - name: sub_agent_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools on agents containing any of these sub-agent names.
          title: Sub Agent Names
        description: Filter tools on agents containing any of these sub-agent names.
      - name: llm_model_names
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools on agents containing any of these llm model names.
          title: Llm Model Names
        description: Filter tools on agents containing any of these llm model names.
      - name: data_source_urls
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: Filter tools on agents containing any of these data source URLs.
          title: Data Source Urls
        description: Filter tools on agents containing any of these data source URLs.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The page to return starting from 1 up to total_pages.
          default: 1
          title: Page
        description: The page to return starting from 1 up to total_pages.
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          description: The number of records per page. 

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/arthur-ai/refs/heads/main/openapi/arthur-ai-agents-v1-api-openapi.yml