ArthurAI Tasks V1 API
The Tasks V1 API from ArthurAI — 7 operation(s) for tasks v1.
The Tasks V1 API from ArthurAI — 7 operation(s) for tasks v1.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/arthurai-tasks-v1-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Arthur Scope Tasks V1 API
version: 0.1.0
tags:
- name: Tasks V1
paths:
/api/v1/models/{model_id}/task:
patch:
tags:
- Tasks V1
summary: Update A Task
description: Submits a job to update the task definition for this model and returns the job ID. When the job finishes, it will upload the latest copy of the task state. Requires model_task_update permission.
operationId: patch_task
security:
- OAuth2AuthorizationCode:
- model_task_update
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PatchTaskRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskMutationResponse'
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
description: Internal Server Error
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Tasks V1
summary: Delete A Task
description: Submits a job to delete the task and the corresponding platform model, and returns the job ID. Requires model_task_delete permission.
operationId: delete_task
security:
- OAuth2AuthorizationCode:
- model_task_delete
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskMutationResponse'
'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'
get:
tags:
- Tasks V1
summary: Get Cached Task State
description: Retrieve the task state cached in the control plane. Requires model_task_read permission.
operationId: get_task_state_cache
security:
- OAuth2AuthorizationCode:
- model_task_read
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskReadResponse'
'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/models/{model_id}/task/sync:
post:
tags:
- Tasks V1
summary: Sync A Task
description: Submits a job to fetch the latest task state and returns the job ID. When the job finishes, it will upload the latest copy of the task state. Requires model_task_sync permission.
operationId: sync_task
security:
- OAuth2AuthorizationCode:
- model_task_sync
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskMutationResponse'
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
description: Internal Server Error
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
description: Bad Request
'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/models/{model_id}/task/cache:
put:
tags:
- Tasks V1
summary: Upload Task State
description: Upload a copy of the task state to cache in the control plane. Requires model_task_put_state_cache permission.
operationId: put_task_state_cache
security:
- OAuth2AuthorizationCode:
- model_task_put_state_cache
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutTaskStateCacheRequest'
responses:
'204':
description: Successful Response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
description: Internal Server Error
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
description: Bad Request
'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/models/{model_id}/task/connection_info:
put:
tags:
- Tasks V1
summary: Upload Task State
description: Upload the task connection information. Requires model_task_put_connection_info permission.
operationId: put_task_connection_info
security:
- OAuth2AuthorizationCode:
- model_task_put_connection_info
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutTaskConnectionInfo'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskConnectionInfo'
'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
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
description: Bad Request
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Tasks V1
summary: Get Task Connection Info
description: Retrieve the task connection information. Requires model_task_get_connection_info permission.
operationId: get_task_connection_info
security:
- OAuth2AuthorizationCode:
- model_task_get_connection_info
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskConnectionInfo'
'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'
delete:
tags:
- Tasks V1
summary: Delete Connection Info
description: Deletes connection information for a model. Requires model_task_delete_connection_info permission.
operationId: delete_connection_info
security:
- OAuth2AuthorizationCode:
- model_task_delete_connection_info
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
responses:
'204':
description: Successful Response
'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/models/{model_id}/task/regenerate_validation_key:
post:
tags:
- Tasks V1
summary: Regenerate Task Validation Key
description: Regenerate the task validation key. Requires model_task_regenerate_validation_key permission.
operationId: post_regenerate_validation_key
security:
- OAuth2AuthorizationCode:
- model_task_regenerate_validation_key
parameters:
- name: model_id
in: path
required: true
schema:
type: string
format: uuid
title: Model Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskValidationKeyRegenerationResponse'
'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/projects/{project_id}/tasks:
post:
tags:
- Tasks V1
summary: Create A Task
description: Submits a job to create a task in the project and returns a job ID. When the job finishes, it will upload a copy of the task state. Requires the project_create_model_task permission.
operationId: project_create_model_task
security:
- OAuth2AuthorizationCode:
- project_create_model_task
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostTaskRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskMutationResponse'
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
description: Internal Server Error
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
description: Bad Request
'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/projects/{project_id}/link_task:
post:
tags:
- Tasks V1
summary: Link An Existing Task To A New Model
description: Submits a job to link an existing task to a new model in the project and returns a job ID. When the job finishes, it will upload a copy of the task state. Requires the project_create_model_link_task permission.
operationId: project_create_model_link_task
security:
- OAuth2AuthorizationCode:
- project_create_model_link_task
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostLinkTaskRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TaskMutationResponse'
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
description: Internal Server Error
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestError'
description: Bad Request
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundError'
description: Not Found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
PostTaskValidationAPIKey:
properties:
id:
type: string
title: Id
description: The Shield ID for the API key.
name:
type: string
title: Name
description: The user-friendly name of the API key.
key:
type: string
title: Key
description: The value of the API key.
type: object
required:
- id
- name
- key
title: PostTaskValidationAPIKey
RegisteredAgentProvider:
type: string
enum:
- gcp
- external
title: RegisteredAgentProvider
TaskMutationResponse:
properties:
job_id:
type: string
format: uuid
title: Job Id
description: Job ID executing the task mutation and retrieval.
type: object
required:
- job_id
title: TaskMutationResponse
ContinuousEvalTransformVariableMappingResponse:
properties:
transform_variable:
type: string
title: Transform Variable
description: Name of the transform variable.
eval_variable:
type: string
title: Eval Variable
description: Name of the eval variable.
type: object
required:
- transform_variable
- eval_variable
title: ContinuousEvalTransformVariableMappingResponse
KeywordsConfig:
properties:
keywords:
items:
type: string
type: array
title: Keywords
description: List of Keywords
type: object
required:
- keywords
title: KeywordsConfig
example:
keywords:
- Blocked_Keyword_1
- Blocked_Keyword_2
LogitBiasItem:
properties:
token_id:
type: integer
title: Token Id
description: Token ID to bias
bias:
type: number
maximum: 100.0
minimum: -100.0
title: Bias
description: Bias value between -100 and 100
type: object
required:
- token_id
- bias
title: LogitBiasItem
TraceTransformDefinition:
properties:
variables:
items:
$ref: '#/components/schemas/TraceTransformVariableDefinition'
type: array
title: Variables
description: List of variable extraction rules.
type: object
required:
- variables
title: TraceTransformDefinition
LLMBaseConfigSettings:
properties:
timeout:
anyOf:
- type: number
- type: 'null'
title: Timeout
description: Request timeout in seconds
temperature:
anyOf:
- type: number
- type: 'null'
title: Temperature
description: Sampling temperature (0.0 to 2.0). Higher values make output more random
top_p:
anyOf:
- type: number
- type: 'null'
title: Top P
description: Top-p sampling parameter (0.0 to 1.0). Alternative to temperature
max_tokens:
anyOf:
- type: integer
- type: 'null'
title: Max Tokens
description: Maximum number of tokens to generate in the response
stop:
anyOf:
- type: string
- type: 'null'
title: Stop
description: Stop sequence(s) where the model should stop generating
presence_penalty:
anyOf:
- type: number
- type: 'null'
title: Presence Penalty
description: Presence penalty (-2.0 to 2.0). Positive values penalize new tokens based on their presence
frequency_penalty:
anyOf:
- type: number
- type: 'null'
title: Frequency Penalty
description: Frequency penalty (-2.0 to 2.0). Positive values penalize tokens based on frequency
seed:
anyOf:
- type: integer
- type: 'null'
title: Seed
description: Random seed for reproducible outputs
logprobs:
anyOf:
- type: boolean
- type: 'null'
title: Logprobs
description: Whether to return log probabilities of output tokens
top_logprobs:
anyOf:
- type: integer
- type: 'null'
title: Top Logprobs
description: Number of most likely tokens to return log probabilities for (1-20)
logit_bias:
anyOf:
- items:
$ref: '#/components/schemas/LogitBiasItem'
type: array
- type: 'null'
title: Logit Bias
description: Modify likelihood of specified tokens appearing in completion
max_completion_tokens:
anyOf:
- type: integer
- type: 'null'
title: Max Completion Tokens
description: Maximum number of completion tokens (alternative to max_tokens)
reasoning_effort:
anyOf:
- $ref: '#/components/schemas/ReasoningEffortEnum'
- type: 'null'
description: Reasoning effort level for models that support it (e.g., OpenAI o1 series)
thinking:
anyOf:
- $ref: '#/components/schemas/AnthropicThinkingParam'
- type: 'null'
description: Anthropic-specific thinking parameter for Claude models
additionalProperties: false
type: object
title: LLMBaseConfigSettings
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
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
TraceTransformResponse:
properties:
id:
type: string
format: uuid
title: Id
description: ID of the transform.
task_id:
type: string
title: Task Id
description: ID of the parent task.
name:
type: string
title: Name
description: Name of the transform.
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: Description of the transform.
definition:
$ref: '#/components/schemas/TraceTransformDefinition'
description: Latest version of the transform definition.
created_at:
type: string
format: date-time
title: Created At
description: Timestamp representing the time of transform creation
updated_at:
type: string
format: date-time
title: Updated At
description: Timestamp representing the time of the last transform update
type: object
required:
- id
- task_id
- name
- definition
- created_at
- updated_at
title: TraceTransformResponse
AnthropicThinkingParam:
properties:
type:
type: string
enum:
- enabled
- adaptive
title: Type
budget_tokens:
type: integer
title: Budget Tokens
additionalProperties: false
type: object
title: AnthropicThinkingParam
ReasoningEffortEnum:
type: string
enum:
- none
- minimal
- low
- medium
- high
- default
title: ReasoningEffortEnum
GCPAgentMetadata:
properties:
project_id:
type: string
title: Project Id
description: Project ID of the agent.
region:
type: string
title: Region
description: Region of the agent.
resource_id:
type: string
title: Resource Id
description: Resource ID of the agent.
type: object
required:
- project_id
- region
- resource_id
title: GCPAgentMetadata
PutTaskConnectionInfo:
properties:
validation_key:
$ref: '#/components/schemas/PostTaskValidationAPIKey'
description: The information for the API key with validation permissions for the task.
api_host:
type: string
title: Api Host
description: Host for the task.
type: object
required:
- validation_key
- api_host
title: PutTaskConnectionInfo
AgentMetadataResponse:
properties:
provider:
$ref: '#/components/schemas/RegisteredAgentProvider'
description: Provider of the registered agent.
gcp_metadata:
anyOf:
- $ref: '#/components/schemas/GCPAgentMetadataResponse'
- type: 'null'
description: Metadata for the agent.
service_names:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Service Names
description: List of service names that send traces to this task
type: object
required:
- provider
title: AgentMetadataResponse
description: Agent metadata for responses.
TaskResponse:
properties:
id:
type: string
title: Id
description: ' ID of the task'
name:
type: string
title: Name
description: Name of the task
created_at:
type: integer
title: Created At
description: Time the task was created in unix milliseconds
updated_at:
type: integer
title: Updated At
description: Time the task was created in unix milliseconds
is_agentic:
anyOf:
- type: boolean
- type: 'null'
title: Is Agentic
description: Whether the task is agentic or not
is_system_task:
anyOf:
- type: boolean
- type: 'null'
title: Is System Task
description: Whether this is a system-managed task (e.g., for traces without a task_id or service name, or for Arthur-created traces)
default: false
is_autocreated:
anyOf:
- type: boolean
- type: 'null'
title: Is Autocreated
description: Whether this task was automatically created by Arthur
default: false
is_archived:
anyOf:
- type: boolean
- type: 'null'
title: Is Archived
description: Whether this task is archived
default: false
agent_metadata:
anyOf:
- $ref: '#/components/schemas/AgentMetadataResponse'
- type: 'null'
description: Metadata to describe the creation source/provider for registered agents.
rules:
items:
$ref: '#/components/schemas/RuleResponse'
type: array
title: Rules
description: List of all the rules for the task.
metrics:
anyOf:
- items:
$ref: '#/components/schemas/MetricResponse'
type: array
- type: 'null'
title: Metrics
description: List of all the metrics for the task.
type: object
required:
- id
- name
- created_at
- updated_at
- rules
title: TaskResponse
PIIConfig:
properties:
disabled_pii_entities:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Disabled Pii Entities
description: 'Optional. List of PII entities to disable. Valid values are: CREDIT_CARD,CRYPTO,DATE_TIME,EMAIL_ADDRESS,IBAN_CODE,IP_ADDRESS,NRP,LOCATION,PERSON,PHONE_NUMBER,MEDICAL_LICENSE,URL,US_BANK_NUMBER,US_DRIVER_LICENSE,US_ITIN,US_PASSPORT,US_SSN'
confidence_threshold:
anyOf:
- type: number
- type: 'null'
title: Confidence Threshold
description: 'Optional. Float (0, 1) indicating the level of tolerable PII to consider the rule passed or failed. Min: 0 (less confident) Max: 1 (very confident). Default: 0'
default: 0
deprecated: true
allow_list:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Allow List
description: Optional. List of strings to pass PII validation.
additionalProperties: false
type: object
title: PIIConfig
example:
allow_list:
- arthur.ai
- Arthur
confidence_threshold: '0.5'
disabled_pii_entities:
- PERSON
- URL
EvalType:
type: string
enum:
- llm_eval
- ml_eval
title: EvalType
TaskValidationAPIKey:
properties:
id:
type: string
title: Id
description: The Shield ID for the API key.
name:
type: string
title: Name
description: The user-friendly name of the API key.
key:
type: string
format: password
title: Key
description: The value of the API key.
writeOnly: true
type: object
required:
- id
- name
- key
title: TaskValidationAPIKey
PostLinkTaskRequest:
properties:
task_id:
type: string
format: uuid
title: Task Id
description: The id of the Shield task to link when creating the new model.
connector_id:
type: string
format: uuid
title: Connector Id
description: The id of the connector with the task to link. The connector must be an engine internal connector.
onboarding_identifier:
anyOf:
- type: string
- type: 'null'
title: Onboarding Identifier
description: An identifier to add to the created model, to make it easy to find after the job completes.
type: object
required:
- task_id
- connector_id
title: PostLinkTaskRequest
TraceTransformVariableDefinition:
properties:
variable_name:
type: string
title: Variable Name
description: Name of the variable to extract.
span_name:
type: string
title: Span Name
description: Name of the span to extract data from.
attribute_path:
type: string
title: Attribute Path
description: Dot-notation path to the attribute within the span (e.g., 'attributes.input.value.sqlQuery').
fallback:
anyOf:
- type: string
- type: 'null'
title: Fallback
description: Fallback value to use if the attribute is not found.
type: object
required:
- variable_name
- span_name
- attribute_path
title: TraceTransformVariableDefinition
PatchTaskRequest:
properties:
rules_to_enable:
items:
type: string
format: uuid
type: array
title: Rules To Enable
description: List of rule IDs to enable on the task.
rules_to_disable:
items:
type: string
format: uuid
type: array
title: Rules To Disable
description: List of rule IDs to disable on the task.
rules_to_archive:
items:
type: string
format: uuid
type: array
title: Rules To Archive
description: List of rule IDs to archive on the task.
rules_to_add:
items:
$ref: '#/components/schemas/NewRuleRequest'
type: array
title: Rules To Add
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/arthurai/refs/heads/main/openapi/arthurai-tasks-v1-api-openapi.yml