API Models

Agent

pydantic model agntcy_acp.models.Agent

A description of an agent supported by this server

Show JSON schema

{
   "title": "Agent",
   "description": "A description of an agent supported by this server",
   "type": "object",
   "properties": {
      "agent_id": {
         "description": "Unique identifier of the agent in this server.",
         "title": "Agent Id",
         "type": "string"
      },
      "metadata": {
         "$ref": "#/$defs/AgentMetadata"
      }
   },
   "$defs": {
      "AgentMetadata": {
         "description": "Basic information associated to the agent",
         "properties": {
            "ref": {
               "$ref": "#/$defs/AgentRef"
            },
            "description": {
               "description": "Description of this agent, which should include what the intended use is, what tasks it accomplishes and how uses input and configs to produce the output and any other side effect",
               "title": "Description",
               "type": "string"
            }
         },
         "required": [
            "ref",
            "description"
         ],
         "title": "AgentMetadata",
         "type": "object"
      },
      "AgentRef": {
         "description": "Reference to an Agent Record in the Agent Directory, it includes name, version and a locator.",
         "properties": {
            "name": {
               "description": "Name of the agent that identifies the agent in its record",
               "title": "Name",
               "type": "string"
            },
            "version": {
               "description": "Version of the agent in its record. Should be formatted according to semantic versioning (https://semver.org)",
               "title": "Version",
               "type": "string"
            },
            "url": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URL of the record. Can be a network location, i.e. an entry in the Agent Directory or a file.",
               "title": "Url"
            }
         },
         "required": [
            "name",
            "version"
         ],
         "title": "AgentRef",
         "type": "object"
      }
   },
   "required": [
      "agent_id",
      "metadata"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• agent_id (str)

• metadata (agntcy_acp.acp_v0.models.agent_metadata.AgentMetadata)

field agent_id: StrictStr [Required]

Unique identifier of the agent in this server.

Constraints:

• strict = True

field metadata: AgentMetadata [Required]

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of Agent from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of Agent from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

AgentACPDescriptor

pydantic model agntcy_acp.models.AgentACPDescriptor

Describe all the ACP specs of an agent, including schemas and protocol features.

Show JSON schema

{
   "title": "AgentACPDescriptor",
   "description": "Describe all the ACP specs of an agent, including schemas and protocol features.",
   "type": "object",
   "properties": {
      "metadata": {
         "$ref": "#/$defs/AgentMetadata"
      },
      "specs": {
         "$ref": "#/$defs/AgentACPSpec"
      }
   },
   "$defs": {
      "AgentACPSpec": {
         "description": "Specification of agent capabilities, config, input, output, and interrupts",
         "properties": {
            "capabilities": {
               "$ref": "#/$defs/AgentCapabilities"
            },
            "input": {
               "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Input",
               "type": "object"
            },
            "output": {
               "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Output",
               "type": "object"
            },
            "custom_streaming_update": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This describes the format of an Update in the streaming.  Must be specified if `streaming.custom` capability is true and cannot be specified otherwise. Format follows: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Custom Streaming Update"
            },
            "thread_state": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This describes the format of ThreadState.  Cannot be specified if `threads` capability is false. If not specified, when `threads` capability is true, then the API to retrieve ThreadState from a Thread or a Run is not available. This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Thread State"
            },
            "config": {
               "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Config",
               "type": "object"
            },
            "interrupts": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AgentACPSpecInterruptsInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of possible interrupts that can be provided by the agent. If `interrupts` capability is true, this needs to have at least one item.",
               "title": "Interrupts"
            }
         },
         "required": [
            "capabilities",
            "input",
            "output",
            "config"
         ],
         "title": "AgentACPSpec",
         "type": "object"
      },
      "AgentACPSpecInterruptsInner": {
         "description": "AgentACPSpecInterruptsInner",
         "properties": {
            "interrupt_type": {
               "description": "Name of this interrupt type. Needs to be unique in the list of interrupts.",
               "title": "Interrupt Type",
               "type": "string"
            },
            "interrupt_payload": {
               "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Interrupt Payload",
               "type": "object"
            },
            "resume_payload": {
               "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Resume Payload",
               "type": "object"
            }
         },
         "required": [
            "interrupt_type",
            "interrupt_payload",
            "resume_payload"
         ],
         "title": "AgentACPSpecInterruptsInner",
         "type": "object"
      },
      "AgentCapabilities": {
         "description": "Declares what invocation features this agent is capable of.",
         "properties": {
            "threads": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "This is `true` if the agent supports run threads. If this is `false`, then the threads tagged with `Threads` are not available. If missing, it means `false`",
               "title": "Threads"
            },
            "interrupts": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "This is `true` if the agent runs can interrupt to request additional input and can be subsequently resumed. If missing, it means `false`",
               "title": "Interrupts"
            },
            "callbacks": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "This is `true` if the agent supports a webhook to report run results. If this is `false`, providing a `webhook` at run creation has no effect. If missing, it means `false`",
               "title": "Callbacks"
            },
            "streaming": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingModes"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "AgentCapabilities",
         "type": "object"
      },
      "AgentMetadata": {
         "description": "Basic information associated to the agent",
         "properties": {
            "ref": {
               "$ref": "#/$defs/AgentRef"
            },
            "description": {
               "description": "Description of this agent, which should include what the intended use is, what tasks it accomplishes and how uses input and configs to produce the output and any other side effect",
               "title": "Description",
               "type": "string"
            }
         },
         "required": [
            "ref",
            "description"
         ],
         "title": "AgentMetadata",
         "type": "object"
      },
      "AgentRef": {
         "description": "Reference to an Agent Record in the Agent Directory, it includes name, version and a locator.",
         "properties": {
            "name": {
               "description": "Name of the agent that identifies the agent in its record",
               "title": "Name",
               "type": "string"
            },
            "version": {
               "description": "Version of the agent in its record. Should be formatted according to semantic versioning (https://semver.org)",
               "title": "Version",
               "type": "string"
            },
            "url": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URL of the record. Can be a network location, i.e. an entry in the Agent Directory or a file.",
               "title": "Url"
            }
         },
         "required": [
            "name",
            "version"
         ],
         "title": "AgentRef",
         "type": "object"
      },
      "StreamingModes": {
         "description": "Supported streaming modes. If missing, streaming is not supported.  If no mode is supported attempts to stream output will result in an error.",
         "properties": {
            "values": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This is `true` if the agent supports values streaming. If `false` or missing, values streaming is not supported. Values streaming consists of a stream of objects of type `ValueRunResultUpdate`, where each one sent over the stream fully replace the previous one.",
               "title": "Values"
            },
            "custom": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This is `true` if the agent supports custom objects streaming. If `false` or missing, custom streaming is not supported. Custom Objects streaming consists of a stream of object whose schema is specified by the agent ACP descriptor under `specs.custom_streaming_update`.",
               "title": "Custom"
            }
         },
         "title": "StreamingModes",
         "type": "object"
      }
   },
   "required": [
      "metadata",
      "specs"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• metadata (agntcy_acp.acp_v0.models.agent_metadata.AgentMetadata)

• specs (agntcy_acp.acp_v0.models.agent_acp_spec.AgentACPSpec)

field metadata: AgentMetadata [Required]

field specs: AgentACPSpec [Required]

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of AgentACPDescriptor from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of AgentACPDescriptor from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

AgentACPSpec

pydantic model agntcy_acp.models.AgentACPSpec

Specification of agent capabilities, config, input, output, and interrupts

Show JSON schema

{
   "title": "AgentACPSpec",
   "description": "Specification of agent capabilities, config, input, output, and interrupts",
   "type": "object",
   "properties": {
      "capabilities": {
         "$ref": "#/$defs/AgentCapabilities"
      },
      "input": {
         "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
         "title": "Input",
         "type": "object"
      },
      "output": {
         "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
         "title": "Output",
         "type": "object"
      },
      "custom_streaming_update": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This describes the format of an Update in the streaming.  Must be specified if `streaming.custom` capability is true and cannot be specified otherwise. Format follows: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
         "title": "Custom Streaming Update"
      },
      "thread_state": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This describes the format of ThreadState.  Cannot be specified if `threads` capability is false. If not specified, when `threads` capability is true, then the API to retrieve ThreadState from a Thread or a Run is not available. This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
         "title": "Thread State"
      },
      "config": {
         "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
         "title": "Config",
         "type": "object"
      },
      "interrupts": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/AgentACPSpecInterruptsInner"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "List of possible interrupts that can be provided by the agent. If `interrupts` capability is true, this needs to have at least one item.",
         "title": "Interrupts"
      }
   },
   "$defs": {
      "AgentACPSpecInterruptsInner": {
         "description": "AgentACPSpecInterruptsInner",
         "properties": {
            "interrupt_type": {
               "description": "Name of this interrupt type. Needs to be unique in the list of interrupts.",
               "title": "Interrupt Type",
               "type": "string"
            },
            "interrupt_payload": {
               "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Interrupt Payload",
               "type": "object"
            },
            "resume_payload": {
               "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
               "title": "Resume Payload",
               "type": "object"
            }
         },
         "required": [
            "interrupt_type",
            "interrupt_payload",
            "resume_payload"
         ],
         "title": "AgentACPSpecInterruptsInner",
         "type": "object"
      },
      "AgentCapabilities": {
         "description": "Declares what invocation features this agent is capable of.",
         "properties": {
            "threads": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "This is `true` if the agent supports run threads. If this is `false`, then the threads tagged with `Threads` are not available. If missing, it means `false`",
               "title": "Threads"
            },
            "interrupts": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "This is `true` if the agent runs can interrupt to request additional input and can be subsequently resumed. If missing, it means `false`",
               "title": "Interrupts"
            },
            "callbacks": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "This is `true` if the agent supports a webhook to report run results. If this is `false`, providing a `webhook` at run creation has no effect. If missing, it means `false`",
               "title": "Callbacks"
            },
            "streaming": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingModes"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "AgentCapabilities",
         "type": "object"
      },
      "StreamingModes": {
         "description": "Supported streaming modes. If missing, streaming is not supported.  If no mode is supported attempts to stream output will result in an error.",
         "properties": {
            "values": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This is `true` if the agent supports values streaming. If `false` or missing, values streaming is not supported. Values streaming consists of a stream of objects of type `ValueRunResultUpdate`, where each one sent over the stream fully replace the previous one.",
               "title": "Values"
            },
            "custom": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This is `true` if the agent supports custom objects streaming. If `false` or missing, custom streaming is not supported. Custom Objects streaming consists of a stream of object whose schema is specified by the agent ACP descriptor under `specs.custom_streaming_update`.",
               "title": "Custom"
            }
         },
         "title": "StreamingModes",
         "type": "object"
      }
   },
   "required": [
      "capabilities",
      "input",
      "output",
      "config"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• capabilities (agntcy_acp.acp_v0.models.agent_capabilities.AgentCapabilities)

• config (Dict[str, Any])

• custom_streaming_update (Dict[str, Any] | None)

• input (Dict[str, Any])

• interrupts (List[agntcy_acp.acp_v0.models.agent_acp_spec_interrupts_inner.AgentACPSpecInterruptsInner] | None)

• output (Dict[str, Any])

• thread_state (Dict[str, Any] | None)

field capabilities: AgentCapabilities [Required]

field config: Dict[str, Any] [Required]

This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object

field custom_streaming_update: Dict[str, Any] | None = None

This describes the format of an Update in the streaming. Must be specified if streaming.custom capability is true and cannot be specified otherwise. Format follows: https://spec.openapis.org/oas/v3.1.1.html#schema-object

field input: Dict[str, Any] [Required]

This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object

field interrupts: List[AgentACPSpecInterruptsInner] | None = None

List of possible interrupts that can be provided by the agent. If interrupts capability is true, this needs to have at least one item.

field output: Dict[str, Any] [Required]

This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object

field thread_state: Dict[str, Any] | None = None

This describes the format of ThreadState. Cannot be specified if threads capability is false. If not specified, when threads capability is true, then the API to retrieve ThreadState from a Thread or a Run is not available. This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of AgentACPSpec from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of AgentACPSpec from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

AgentACPSpecInterruptsInner

pydantic model agntcy_acp.models.AgentACPSpecInterruptsInner

AgentACPSpecInterruptsInner

Show JSON schema

{
   "title": "AgentACPSpecInterruptsInner",
   "description": "AgentACPSpecInterruptsInner",
   "type": "object",
   "properties": {
      "interrupt_type": {
         "description": "Name of this interrupt type. Needs to be unique in the list of interrupts.",
         "title": "Interrupt Type",
         "type": "string"
      },
      "interrupt_payload": {
         "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
         "title": "Interrupt Payload",
         "type": "object"
      },
      "resume_payload": {
         "description": "This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object",
         "title": "Resume Payload",
         "type": "object"
      }
   },
   "required": [
      "interrupt_type",
      "interrupt_payload",
      "resume_payload"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• interrupt_payload (Dict[str, Any])

• interrupt_type (str)

• resume_payload (Dict[str, Any])

field interrupt_payload: Dict[str, Any] [Required]

This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object

field interrupt_type: StrictStr [Required]

Name of this interrupt type. Needs to be unique in the list of interrupts.

Constraints:

• strict = True

field resume_payload: Dict[str, Any] [Required]

This object contains an instance of an OpenAPI schema object, formatted as per the OpenAPI specs: https://spec.openapis.org/oas/v3.1.1.html#schema-object

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of AgentACPSpecInterruptsInner from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of AgentACPSpecInterruptsInner from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

AgentCapabilities

pydantic model agntcy_acp.models.AgentCapabilities

Declares what invocation features this agent is capable of.

Show JSON schema

{
   "title": "AgentCapabilities",
   "description": "Declares what invocation features this agent is capable of.",
   "type": "object",
   "properties": {
      "threads": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "This is `true` if the agent supports run threads. If this is `false`, then the threads tagged with `Threads` are not available. If missing, it means `false`",
         "title": "Threads"
      },
      "interrupts": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "This is `true` if the agent runs can interrupt to request additional input and can be subsequently resumed. If missing, it means `false`",
         "title": "Interrupts"
      },
      "callbacks": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "This is `true` if the agent supports a webhook to report run results. If this is `false`, providing a `webhook` at run creation has no effect. If missing, it means `false`",
         "title": "Callbacks"
      },
      "streaming": {
         "anyOf": [
            {
               "$ref": "#/$defs/StreamingModes"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "StreamingModes": {
         "description": "Supported streaming modes. If missing, streaming is not supported.  If no mode is supported attempts to stream output will result in an error.",
         "properties": {
            "values": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This is `true` if the agent supports values streaming. If `false` or missing, values streaming is not supported. Values streaming consists of a stream of objects of type `ValueRunResultUpdate`, where each one sent over the stream fully replace the previous one.",
               "title": "Values"
            },
            "custom": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "This is `true` if the agent supports custom objects streaming. If `false` or missing, custom streaming is not supported. Custom Objects streaming consists of a stream of object whose schema is specified by the agent ACP descriptor under `specs.custom_streaming_update`.",
               "title": "Custom"
            }
         },
         "title": "StreamingModes",
         "type": "object"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• callbacks (bool | None)

• interrupts (bool | None)

• streaming (agntcy_acp.acp_v0.models.streaming_modes.StreamingModes | None)

• threads (bool | None)

field callbacks: StrictBool | None = False

This is true if the agent supports a webhook to report run results. If this is false, providing a webhook at run creation has no effect. If missing, it means false

field interrupts: StrictBool | None = False

This is true if the agent runs can interrupt to request additional input and can be subsequently resumed. If missing, it means false

field streaming: StreamingModes | None = None

field threads: StrictBool | None = False

This is true if the agent supports run threads. If this is false, then the threads tagged with Threads are not available. If missing, it means false

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of AgentCapabilities from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of AgentCapabilities from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

AgentMetadata

pydantic model agntcy_acp.models.AgentMetadata

Basic information associated to the agent

Show JSON schema

{
   "title": "AgentMetadata",
   "description": "Basic information associated to the agent",
   "type": "object",
   "properties": {
      "ref": {
         "$ref": "#/$defs/AgentRef"
      },
      "description": {
         "description": "Description of this agent, which should include what the intended use is, what tasks it accomplishes and how uses input and configs to produce the output and any other side effect",
         "title": "Description",
         "type": "string"
      }
   },
   "$defs": {
      "AgentRef": {
         "description": "Reference to an Agent Record in the Agent Directory, it includes name, version and a locator.",
         "properties": {
            "name": {
               "description": "Name of the agent that identifies the agent in its record",
               "title": "Name",
               "type": "string"
            },
            "version": {
               "description": "Version of the agent in its record. Should be formatted according to semantic versioning (https://semver.org)",
               "title": "Version",
               "type": "string"
            },
            "url": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "URL of the record. Can be a network location, i.e. an entry in the Agent Directory or a file.",
               "title": "Url"
            }
         },
         "required": [
            "name",
            "version"
         ],
         "title": "AgentRef",
         "type": "object"
      }
   },
   "required": [
      "ref",
      "description"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• description (str)

• ref (agntcy_acp.acp_v0.models.agent_ref.AgentRef)

field description: StrictStr [Required]

Description of this agent, which should include what the intended use is, what tasks it accomplishes and how uses input and configs to produce the output and any other side effect

Constraints:

• strict = True

field ref: AgentRef [Required]

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of AgentMetadata from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of AgentMetadata from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

AgentRef

pydantic model agntcy_acp.models.AgentRef

Reference to an Agent Record in the Agent Directory, it includes name, version and a locator.

Show JSON schema

{
   "title": "AgentRef",
   "description": "Reference to an Agent Record in the Agent Directory, it includes name, version and a locator.",
   "type": "object",
   "properties": {
      "name": {
         "description": "Name of the agent that identifies the agent in its record",
         "title": "Name",
         "type": "string"
      },
      "version": {
         "description": "Version of the agent in its record. Should be formatted according to semantic versioning (https://semver.org)",
         "title": "Version",
         "type": "string"
      },
      "url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "URL of the record. Can be a network location, i.e. an entry in the Agent Directory or a file.",
         "title": "Url"
      }
   },
   "required": [
      "name",
      "version"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• name (str)

• url (str | None)

• version (str)

field name: StrictStr [Required]

Name of the agent that identifies the agent in its record

Constraints:

• strict = True

field url: StrictStr | None = None

URL of the record. Can be a network location, i.e. an entry in the Agent Directory or a file.

field version: StrictStr [Required]

Version of the agent in its record. Should be formatted according to semantic versioning (https://semver.org)

Constraints:

• strict = True

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of AgentRef from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of AgentRef from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

AgentSearchRequest

pydantic model agntcy_acp.models.AgentSearchRequest

Payload for listing agents.

Show JSON schema

{
   "title": "AgentSearchRequest",
   "description": "Payload for listing agents.",
   "type": "object",
   "properties": {
      "name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Match all agents with the name specified.",
         "title": "Name"
      },
      "version": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Match all agents with the version specified. Formatted according to semantic versioning (https://semver.org)",
         "title": "Version"
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 1000,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "Maximum number to return.",
         "title": "Limit"
      },
      "offset": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Offset to start from.",
         "title": "Offset"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• limit (int | None)

• name (str | None)

• offset (int | None)

• version (str | None)

field limit: Annotated[int, Field(le=1000, strict=True, ge=1)] | None = 10

Maximum number to return.

field name: StrictStr | None = None

Match all agents with the name specified.

field offset: Annotated[int, Field(strict=True, ge=0)] | None = 0

Offset to start from.

field version: StrictStr | None = None

Match all agents with the version specified. Formatted according to semantic versioning (https://semver.org)

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of AgentSearchRequest from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of AgentSearchRequest from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

Config

pydantic model agntcy_acp.models.Config

The configuration for the agent.

Show JSON schema

{
   "title": "Config",
   "description": "The configuration for the agent.",
   "type": "object",
   "properties": {
      "tags": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tags"
      },
      "recursion_limit": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Recursion Limit"
      },
      "configurable": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
         "title": "Configurable"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• configurable (Dict[str, Any] | None)

• recursion_limit (int | None)

• tags (List[str] | None)

field configurable: Dict[str, Any] | None = None

The configuration for this agent. The schema is described in agent ACP descriptor under ‘spec.config’. If missing, default values are used.

field recursion_limit: StrictInt | None = None

field tags: List[StrictStr] | None = None

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of Config from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of Config from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

Content

pydantic model agntcy_acp.models.Content

The content of the message.

Show JSON schema

{
   "title": "Content",
   "description": "The content of the message.",
   "type": "object",
   "properties": {
      "oneof_schema_1_validator": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Oneof Schema 1 Validator"
      },
      "oneof_schema_2_validator": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/ContentOneOfInner"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Oneof Schema 2 Validator"
      },
      "actual_instance": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/ContentOneOfInner"
               },
               "type": "array"
            },
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Actual Instance"
      },
      "one_of_schemas": {
         "default": [
            "List[ContentOneOfInner]",
            "str"
         ],
         "items": {
            "type": "string"
         },
         "title": "One Of Schemas",
         "type": "array",
         "uniqueItems": true
      }
   },
   "$defs": {
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      }
   }
}

Config:

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• actual_instance (List[agntcy_acp.acp_v0.models.content_one_of_inner.ContentOneOfInner] | str | None)

• one_of_schemas (Set[str])

• oneof_schema_1_validator (str | None)

• oneof_schema_2_validator (List[agntcy_acp.acp_v0.models.content_one_of_inner.ContentOneOfInner] | None)

Validators:

• actual_instance_must_validate_oneof » actual_instance

field actual_instance: List[ContentOneOfInner] | str | None = None

Validated by:

• actual_instance_must_validate_oneof

field one_of_schemas: Set[str] = {'List[ContentOneOfInner]', 'str'}

field oneof_schema_1_validator: StrictStr | None = None

field oneof_schema_2_validator: List[ContentOneOfInner] | None = None

validator actual_instance_must_validate_oneof  »  actual_instance

classmethod from_dict(obj: str | Dict[str, Any]) → Self

classmethod from_json(json_str: str) → Self

Returns the object represented by the json string

to_dict() → Dict[str, Any] | List[ContentOneOfInner] | str | None

Returns the dict representation of the actual instance

to_json() → str

Returns the JSON representation of the actual instance

to_str() → str

Returns the string representation of the actual instance

ContentOneOfInner

pydantic model agntcy_acp.models.ContentOneOfInner

ContentOneOfInner

Show JSON schema

{
   "title": "ContentOneOfInner",
   "description": "ContentOneOfInner",
   "type": "object",
   "properties": {
      "anyof_schema_1_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/MessageTextBlock"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "anyof_schema_2_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/MessageAnyBlock"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "actual_instance": {
         "default": null,
         "title": "Actual Instance"
      },
      "any_of_schemas": {
         "default": [
            "MessageTextBlock",
            "MessageAnyBlock"
         ],
         "items": {
            "type": "string"
         },
         "title": "Any Of Schemas",
         "type": "array",
         "uniqueItems": true
      }
   },
   "$defs": {
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      }
   }
}

Config:

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• actual_instance (Any)

• any_of_schemas (Set[str])

• anyof_schema_1_validator (agntcy_acp.acp_v0.models.message_text_block.MessageTextBlock | None)

• anyof_schema_2_validator (agntcy_acp.acp_v0.models.message_any_block.MessageAnyBlock | None)

Validators:

• actual_instance_must_validate_anyof » actual_instance

field actual_instance: Any = None

Validated by:

• actual_instance_must_validate_anyof

field any_of_schemas: Set[str] = {'MessageAnyBlock', 'MessageTextBlock'}

field anyof_schema_1_validator: MessageTextBlock | None = None

field anyof_schema_2_validator: MessageAnyBlock | None = None

validator actual_instance_must_validate_anyof  »  actual_instance

classmethod from_dict(obj: Dict[str, Any]) → Self

classmethod from_json(json_str: str) → Self

Returns the object represented by the json string

to_dict() → Dict[str, Any] | MessageAnyBlock | MessageTextBlock | None

Returns the dict representation of the actual instance

to_json() → str

Returns the JSON representation of the actual instance

to_str() → str

Returns the string representation of the actual instance

CustomRunResultUpdate

pydantic model agntcy_acp.models.CustomRunResultUpdate

Object holding a custom defined update of the agent result during streaming.

Show JSON schema

{
   "title": "CustomRunResultUpdate",
   "description": "Object holding a custom defined update of the agent result during streaming.",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "type": "string"
      },
      "run_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ID of the run.",
         "title": "Run Id"
      },
      "status": {
         "$ref": "#/$defs/RunStatus",
         "description": "Status of the Run when this result was generated"
      },
      "update": {
         "description": "An update in the SSE event streaming where streaming mode is set to custom. The schema is described in agent ACP descriptor under 'spec.custom_streaming_update'.",
         "title": "Update",
         "type": "object"
      }
   },
   "$defs": {
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      }
   },
   "required": [
      "type",
      "status",
      "update"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• run_id (str | None)

• status (agntcy_acp.acp_v0.models.run_status.RunStatus)

• type (str)

• update (Dict[str, Any])

Validators:

• type_validate_enum » type

field run_id: StrictStr | None = None

The ID of the run.

field status: RunStatus [Required]

Status of the Run when this result was generated

field type: StrictStr [Required]

Constraints:

• strict = True

Validated by:

• type_validate_enum

field update: Dict[str, Any] [Required]

An update in the SSE event streaming where streaming mode is set to custom. The schema is described in agent ACP descriptor under ‘spec.custom_streaming_update’.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of CustomRunResultUpdate from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of CustomRunResultUpdate from a JSON string

validator type_validate_enum  »  type

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

Message

pydantic model agntcy_acp.models.Message

Message

Show JSON schema

{
   "title": "Message",
   "description": "Message",
   "type": "object",
   "properties": {
      "role": {
         "description": "The role of the message.",
         "title": "Role",
         "type": "string"
      },
      "content": {
         "$ref": "#/$defs/Content"
      },
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ID of the message.",
         "title": "Id"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The metadata of the message.",
         "title": "Metadata"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      }
   },
   "required": [
      "role",
      "content"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• content (agntcy_acp.acp_v0.models.content.Content)

• id (str | None)

• metadata (Dict[str, Any] | None)

• role (str)

field content: Content [Required]

field id: StrictStr | None = None

The ID of the message.

field metadata: Dict[str, Any] | None = None

The metadata of the message.

field role: StrictStr [Required]

The role of the message.

Constraints:

• strict = True

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of Message from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of Message from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

MessageAnyBlock

pydantic model agntcy_acp.models.MessageAnyBlock

MessageAnyBlock

Show JSON schema

{
   "title": "MessageAnyBlock",
   "description": "MessageAnyBlock",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "type": "string"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata"
      }
   },
   "required": [
      "type"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• metadata (Dict[str, Any] | None)

• type (str)

field metadata: Dict[str, Any] | None = None

field type: StrictStr [Required]

Constraints:

• strict = True

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of MessageAnyBlock from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of MessageAnyBlock from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

MessageTextBlock

pydantic model agntcy_acp.models.MessageTextBlock

MessageTextBlock

Show JSON schema

{
   "title": "MessageTextBlock",
   "description": "MessageTextBlock",
   "type": "object",
   "properties": {
      "text": {
         "title": "Text",
         "type": "string"
      },
      "type": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "title": "Type"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Metadata"
      }
   },
   "required": [
      "text",
      "type"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• metadata (Dict[str, Any] | None)

• text (str)

• type (Any | None)

field metadata: Dict[str, Any] | None = None

field text: StrictStr [Required]

Constraints:

• strict = True

field type: Any | None [Required]

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of MessageTextBlock from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of MessageTextBlock from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

Run

pydantic model agntcy_acp.models.Run

Holds common information of a run

Show JSON schema

{
   "title": "Run",
   "description": "Holds common information of a run",
   "type": "object",
   "properties": {
      "run_id": {
         "description": "The ID of the run.",
         "title": "Run Id",
         "type": "string"
      },
      "thread_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.",
         "title": "Thread Id"
      },
      "agent_id": {
         "description": "The agent that was used for this run.",
         "title": "Agent Id",
         "type": "string"
      },
      "created_at": {
         "description": "The time the run was created.",
         "format": "date-time",
         "title": "Created At",
         "type": "string"
      },
      "updated_at": {
         "description": "The last time the run was updated.",
         "format": "date-time",
         "title": "Updated At",
         "type": "string"
      },
      "status": {
         "$ref": "#/$defs/RunStatus",
         "description": "The status of the run. One of 'pending', 'error', 'success', 'timeout', 'interrupted'."
      }
   },
   "$defs": {
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      }
   },
   "required": [
      "run_id",
      "agent_id",
      "created_at",
      "updated_at",
      "status"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• agent_id (str)

• created_at (datetime.datetime)

• run_id (str)

• status (agntcy_acp.acp_v0.models.run_status.RunStatus)

• thread_id (str | None)

• updated_at (datetime.datetime)

field agent_id: StrictStr [Required]

The agent that was used for this run.

Constraints:

• strict = True

field created_at: datetime [Required]

The time the run was created.

field run_id: StrictStr [Required]

The ID of the run.

Constraints:

• strict = True

field status: RunStatus [Required]

The status of the run. One of ‘pending’, ‘error’, ‘success’, ‘timeout’, ‘interrupted’.

field thread_id: StrictStr | None = None

Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.

field updated_at: datetime [Required]

The last time the run was updated.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of Run from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of Run from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunCreate

pydantic model agntcy_acp.models.RunCreate

Payload for creating a run.

Show JSON schema

{
   "title": "RunCreate",
   "description": "Payload for creating a run.",
   "type": "object",
   "properties": {
      "agent_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The agent ID to run. If not provided will use the default agent for this service.",
         "title": "Agent Id"
      },
      "input": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The input to the agent. The schema is described in agent ACP descriptor under 'spec.thread_state'.'input'.",
         "title": "Input"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Metadata to assign to the run.",
         "title": "Metadata"
      },
      "config": {
         "anyOf": [
            {
               "$ref": "#/$defs/Config"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "webhook": {
         "anyOf": [
            {
               "maxLength": 65536,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Webhook to call upon change of run status. This is a url that accepts a POST containing the `Run` object as body. See Callbacks definition.",
         "title": "Webhook"
      },
      "stream_mode": {
         "anyOf": [
            {
               "$ref": "#/$defs/StreamMode"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "on_disconnect": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "cancel",
         "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.",
         "title": "On Disconnect"
      },
      "multitask_strategy": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "reject",
         "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.",
         "title": "Multitask Strategy"
      },
      "after_seconds": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of seconds to wait before starting the run. Use to schedule future runs.",
         "title": "After Seconds"
      }
   },
   "$defs": {
      "Config": {
         "description": "The configuration for the agent.",
         "properties": {
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "recursion_limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Recursion Limit"
            },
            "configurable": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
               "title": "Configurable"
            }
         },
         "title": "Config",
         "type": "object"
      },
      "StreamMode": {
         "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/StreamingMode"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Anyof Schema 1 Validator"
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "List[StreamingMode]",
                  "StreamingMode"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "StreamMode",
         "type": "object"
      },
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• after_seconds (int | None)

• agent_id (str | None)

• config (agntcy_acp.acp_v0.models.config.Config | None)

• input (Dict[str, Any] | None)

• metadata (Dict[str, Any] | None)

• multitask_strategy (str | None)

• on_disconnect (str | None)

• stream_mode (agntcy_acp.acp_v0.models.stream_mode.StreamMode | None)

• webhook (str | None)

Validators:

• multitask_strategy_validate_enum » multitask_strategy

• on_disconnect_validate_enum » on_disconnect

field after_seconds: StrictInt | None = None

The number of seconds to wait before starting the run. Use to schedule future runs.

field agent_id: StrictStr | None = None

The agent ID to run. If not provided will use the default agent for this service.

field config: Config | None = None

field input: Dict[str, Any] | None = None

The input to the agent. The schema is described in agent ACP descriptor under ‘spec.thread_state’.’input’.

field metadata: Dict[str, Any] | None = None

Metadata to assign to the run.

field multitask_strategy: StrictStr | None = 'reject'

Multitask strategy to use. Must be one of ‘reject’, ‘interrupt’, ‘rollback’, or ‘enqueue’.

Validated by:

• multitask_strategy_validate_enum

field on_disconnect: StrictStr | None = 'cancel'

The disconnect mode to use. Must be one of ‘cancel’ or ‘continue’.

Validated by:

• on_disconnect_validate_enum

field stream_mode: StreamMode | None = None

field webhook: Annotated[str, Field(min_length=1, strict=True, max_length=65536)] | None = None

Webhook to call upon change of run status. This is a url that accepts a POST containing the Run object as body. See Callbacks definition.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunCreate from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunCreate from a JSON string

validator multitask_strategy_validate_enum  »  multitask_strategy

Validates the enum

validator on_disconnect_validate_enum  »  on_disconnect

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunCreateStateful

pydantic model agntcy_acp.models.RunCreateStateful

Payload for creating a stateful run.

Show JSON schema

{
   "title": "RunCreateStateful",
   "description": "Payload for creating a stateful run.",
   "type": "object",
   "properties": {
      "agent_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The agent ID to run. If not provided will use the default agent for this service.",
         "title": "Agent Id"
      },
      "input": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The input to the agent. The schema is described in agent ACP descriptor under 'spec.thread_state'.'input'.",
         "title": "Input"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Metadata to assign to the run.",
         "title": "Metadata"
      },
      "config": {
         "anyOf": [
            {
               "$ref": "#/$defs/Config"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "webhook": {
         "anyOf": [
            {
               "maxLength": 65536,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Webhook to call upon change of run status. This is a url that accepts a POST containing the `Run` object as body. See Callbacks definition.",
         "title": "Webhook"
      },
      "stream_mode": {
         "anyOf": [
            {
               "$ref": "#/$defs/StreamMode"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "on_disconnect": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "cancel",
         "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.",
         "title": "On Disconnect"
      },
      "multitask_strategy": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "reject",
         "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.",
         "title": "Multitask Strategy"
      },
      "after_seconds": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of seconds to wait before starting the run. Use to schedule future runs.",
         "title": "After Seconds"
      },
      "stream_subgraphs": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": false,
         "description": "Whether to stream output from subgraphs.",
         "title": "Stream Subgraphs"
      },
      "if_not_exists": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "reject",
         "description": "How to handle missing thread. Must be either 'reject' (raise error if missing), or 'create' (create new thread).",
         "title": "If Not Exists"
      }
   },
   "$defs": {
      "Config": {
         "description": "The configuration for the agent.",
         "properties": {
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "recursion_limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Recursion Limit"
            },
            "configurable": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
               "title": "Configurable"
            }
         },
         "title": "Config",
         "type": "object"
      },
      "StreamMode": {
         "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/StreamingMode"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Anyof Schema 1 Validator"
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "List[StreamingMode]",
                  "StreamingMode"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "StreamMode",
         "type": "object"
      },
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• after_seconds (int | None)

• agent_id (str | None)

• config (agntcy_acp.acp_v0.models.config.Config | None)

• if_not_exists (str | None)

• input (Dict[str, Any] | None)

• metadata (Dict[str, Any] | None)

• multitask_strategy (str | None)

• on_disconnect (str | None)

• stream_mode (agntcy_acp.acp_v0.models.stream_mode.StreamMode | None)

• stream_subgraphs (bool | None)

• webhook (str | None)

Validators:

• if_not_exists_validate_enum » if_not_exists

• multitask_strategy_validate_enum » multitask_strategy

• on_disconnect_validate_enum » on_disconnect

field after_seconds: StrictInt | None = None

The number of seconds to wait before starting the run. Use to schedule future runs.

field agent_id: StrictStr | None = None

The agent ID to run. If not provided will use the default agent for this service.

field config: Config | None = None

field if_not_exists: StrictStr | None = 'reject'

How to handle missing thread. Must be either ‘reject’ (raise error if missing), or ‘create’ (create new thread).

Validated by:

• if_not_exists_validate_enum

field input: Dict[str, Any] | None = None

The input to the agent. The schema is described in agent ACP descriptor under ‘spec.thread_state’.’input’.

field metadata: Dict[str, Any] | None = None

Metadata to assign to the run.

field multitask_strategy: StrictStr | None = 'reject'

Multitask strategy to use. Must be one of ‘reject’, ‘interrupt’, ‘rollback’, or ‘enqueue’.

Validated by:

• multitask_strategy_validate_enum

field on_disconnect: StrictStr | None = 'cancel'

The disconnect mode to use. Must be one of ‘cancel’ or ‘continue’.

Validated by:

• on_disconnect_validate_enum

field stream_mode: StreamMode | None = None

field stream_subgraphs: StrictBool | None = False

Whether to stream output from subgraphs.

field webhook: Annotated[str, Field(min_length=1, strict=True, max_length=65536)] | None = None

Webhook to call upon change of run status. This is a url that accepts a POST containing the Run object as body. See Callbacks definition.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunCreateStateful from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunCreateStateful from a JSON string

validator if_not_exists_validate_enum  »  if_not_exists

Validates the enum

validator multitask_strategy_validate_enum  »  multitask_strategy

Validates the enum

validator on_disconnect_validate_enum  »  on_disconnect

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunCreateStateless

pydantic model agntcy_acp.models.RunCreateStateless

Payload for creating a stateless run.

Show JSON schema

{
   "title": "RunCreateStateless",
   "description": "Payload for creating a stateless run.",
   "type": "object",
   "properties": {
      "agent_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The agent ID to run. If not provided will use the default agent for this service.",
         "title": "Agent Id"
      },
      "input": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The input to the agent. The schema is described in agent ACP descriptor under 'spec.thread_state'.'input'.",
         "title": "Input"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Metadata to assign to the run.",
         "title": "Metadata"
      },
      "config": {
         "anyOf": [
            {
               "$ref": "#/$defs/Config"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "webhook": {
         "anyOf": [
            {
               "maxLength": 65536,
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Webhook to call upon change of run status. This is a url that accepts a POST containing the `Run` object as body. See Callbacks definition.",
         "title": "Webhook"
      },
      "stream_mode": {
         "anyOf": [
            {
               "$ref": "#/$defs/StreamMode"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "on_disconnect": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "cancel",
         "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.",
         "title": "On Disconnect"
      },
      "multitask_strategy": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "reject",
         "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.",
         "title": "Multitask Strategy"
      },
      "after_seconds": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The number of seconds to wait before starting the run. Use to schedule future runs.",
         "title": "After Seconds"
      },
      "on_completion": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "delete",
         "description": "Whether to delete or keep the thread created for a stateless run. Must be one of 'delete' or 'keep'.",
         "title": "On Completion"
      }
   },
   "$defs": {
      "Config": {
         "description": "The configuration for the agent.",
         "properties": {
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "recursion_limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Recursion Limit"
            },
            "configurable": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
               "title": "Configurable"
            }
         },
         "title": "Config",
         "type": "object"
      },
      "StreamMode": {
         "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/StreamingMode"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Anyof Schema 1 Validator"
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "List[StreamingMode]",
                  "StreamingMode"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "StreamMode",
         "type": "object"
      },
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• after_seconds (int | None)

• agent_id (str | None)

• config (agntcy_acp.acp_v0.models.config.Config | None)

• input (Dict[str, Any] | None)

• metadata (Dict[str, Any] | None)

• multitask_strategy (str | None)

• on_completion (str | None)

• on_disconnect (str | None)

• stream_mode (agntcy_acp.acp_v0.models.stream_mode.StreamMode | None)

• webhook (str | None)

Validators:

• multitask_strategy_validate_enum » multitask_strategy

• on_completion_validate_enum » on_completion

• on_disconnect_validate_enum » on_disconnect

field after_seconds: StrictInt | None = None

The number of seconds to wait before starting the run. Use to schedule future runs.

field agent_id: StrictStr | None = None

The agent ID to run. If not provided will use the default agent for this service.

field config: Config | None = None

field input: Dict[str, Any] | None = None

The input to the agent. The schema is described in agent ACP descriptor under ‘spec.thread_state’.’input’.

field metadata: Dict[str, Any] | None = None

Metadata to assign to the run.

field multitask_strategy: StrictStr | None = 'reject'

Multitask strategy to use. Must be one of ‘reject’, ‘interrupt’, ‘rollback’, or ‘enqueue’.

Validated by:

• multitask_strategy_validate_enum

field on_completion: StrictStr | None = 'delete'

Whether to delete or keep the thread created for a stateless run. Must be one of ‘delete’ or ‘keep’.

Validated by:

• on_completion_validate_enum

field on_disconnect: StrictStr | None = 'cancel'

The disconnect mode to use. Must be one of ‘cancel’ or ‘continue’.

Validated by:

• on_disconnect_validate_enum

field stream_mode: StreamMode | None = None

field webhook: Annotated[str, Field(min_length=1, strict=True, max_length=65536)] | None = None

Webhook to call upon change of run status. This is a url that accepts a POST containing the Run object as body. See Callbacks definition.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunCreateStateless from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunCreateStateless from a JSON string

validator multitask_strategy_validate_enum  »  multitask_strategy

Validates the enum

validator on_completion_validate_enum  »  on_completion

Validates the enum

validator on_disconnect_validate_enum  »  on_disconnect

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunError

pydantic model agntcy_acp.models.RunError

Run terminated with an error

Show JSON schema

{
   "title": "RunError",
   "description": "Run terminated with an error",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "type": "string"
      },
      "run_id": {
         "description": "The ID of the run.",
         "title": "Run Id",
         "type": "string"
      },
      "errcode": {
         "description": "code of the error",
         "title": "Errcode",
         "type": "integer"
      },
      "description": {
         "description": "description of the error",
         "title": "Description",
         "type": "string"
      }
   },
   "required": [
      "type",
      "run_id",
      "errcode",
      "description"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• description (str)

• errcode (int)

• run_id (str)

• type (str)

Validators:

• type_validate_enum » type

field description: StrictStr [Required]

description of the error

Constraints:

• strict = True

field errcode: StrictInt [Required]

code of the error

Constraints:

• strict = True

field run_id: StrictStr [Required]

The ID of the run.

Constraints:

• strict = True

field type: StrictStr [Required]

Constraints:

• strict = True

Validated by:

• type_validate_enum

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunError from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunError from a JSON string

validator type_validate_enum  »  type

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunInterrupt

pydantic model agntcy_acp.models.RunInterrupt

Interrupt occurred during a Run

Show JSON schema

{
   "title": "RunInterrupt",
   "description": "Interrupt occurred during a Run",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "type": "string"
      },
      "interrupt": {
         "description": "This schema describes the interrupt payload. Actual schema describes a polimorphic object, which means a schema structured with `oneOf` and `discriminator`. The discriminator is the `interrupt_type`, while the schemas will be the ones defined in the agent spec under `interrupts`/`interrupt_payload` For example:          oneOf:   - $ref: '#/components/schemas/ApprovalInterruptPayload'   - $ref: '#/components/schemas/QuestionInterruptPayload' discriminator:   propertyName: interruput_type   mapping:     approval: '#/components/schemas/ApprovalInterruptPayload'     question: '#/components/schemas/QuestionInterruptPayload'",
         "title": "Interrupt",
         "type": "object"
      }
   },
   "required": [
      "type",
      "interrupt"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• interrupt (Dict[str, Any])

• type (str)

Validators:

• type_validate_enum » type

field interrupt: Dict[str, Any] [Required]

This schema describes the interrupt payload. Actual schema describes a polimorphic object, which means a schema structured with oneOf and discriminator. The discriminator is the interrupt_type, while the schemas will be the ones defined in the agent spec under interrupts/interrupt_payload For example: oneOf: - $ref: ‘#/components/schemas/ApprovalInterruptPayload’ - $ref: ‘#/components/schemas/QuestionInterruptPayload’ discriminator: propertyName: interruput_type mapping: approval: ‘#/components/schemas/ApprovalInterruptPayload’ question: ‘#/components/schemas/QuestionInterruptPayload’

field type: StrictStr [Required]

Constraints:

• strict = True

Validated by:

• type_validate_enum

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunInterrupt from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunInterrupt from a JSON string

validator type_validate_enum  »  type

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunOutput

pydantic model agntcy_acp.models.RunOutput

Output of a Run. Can be the final result or an interrupt.

Show JSON schema

{
   "title": "RunOutput",
   "description": "Output of a Run. Can be the final result or an interrupt.",
   "type": "object",
   "properties": {
      "oneof_schema_1_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunResult"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "oneof_schema_2_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunInterrupt"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "oneof_schema_3_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunError"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "actual_instance": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunError"
            },
            {
               "$ref": "#/$defs/RunInterrupt"
            },
            {
               "$ref": "#/$defs/RunResult"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Actual Instance"
      },
      "one_of_schemas": {
         "default": [
            "RunResult",
            "RunError",
            "RunInterrupt"
         ],
         "items": {
            "type": "string"
         },
         "title": "One Of Schemas",
         "type": "array",
         "uniqueItems": true
      },
      "discriminator_value_class_map": {
         "additionalProperties": {
            "type": "string"
         },
         "default": {},
         "title": "Discriminator Value Class Map",
         "type": "object"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "RunError": {
         "description": "Run terminated with an error",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "run_id": {
               "description": "The ID of the run.",
               "title": "Run Id",
               "type": "string"
            },
            "errcode": {
               "description": "code of the error",
               "title": "Errcode",
               "type": "integer"
            },
            "description": {
               "description": "description of the error",
               "title": "Description",
               "type": "string"
            }
         },
         "required": [
            "type",
            "run_id",
            "errcode",
            "description"
         ],
         "title": "RunError",
         "type": "object"
      },
      "RunInterrupt": {
         "description": "Interrupt occurred during a Run",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "interrupt": {
               "description": "This schema describes the interrupt payload. Actual schema describes a polimorphic object, which means a schema structured with `oneOf` and `discriminator`. The discriminator is the `interrupt_type`, while the schemas will be the ones defined in the agent spec under `interrupts`/`interrupt_payload` For example:          oneOf:   - $ref: '#/components/schemas/ApprovalInterruptPayload'   - $ref: '#/components/schemas/QuestionInterruptPayload' discriminator:   propertyName: interruput_type   mapping:     approval: '#/components/schemas/ApprovalInterruptPayload'     question: '#/components/schemas/QuestionInterruptPayload'",
               "title": "Interrupt",
               "type": "object"
            }
         },
         "required": [
            "type",
            "interrupt"
         ],
         "title": "RunInterrupt",
         "type": "object"
      },
      "RunResult": {
         "description": "Final result of a Run.",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "values": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The output of the agent. The schema is described in agent ACP descriptor under 'spec.output'.",
               "title": "Values"
            },
            "messages": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Message"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The messages returned by the run.",
               "title": "Messages"
            }
         },
         "required": [
            "type"
         ],
         "title": "RunResult",
         "type": "object"
      }
   }
}

Config:

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• actual_instance (agntcy_acp.acp_v0.models.run_error.RunError | agntcy_acp.acp_v0.models.run_interrupt.RunInterrupt | agntcy_acp.acp_v0.models.run_result.RunResult | None)

• discriminator_value_class_map (Dict[str, str])

• one_of_schemas (Set[str])

• oneof_schema_1_validator (agntcy_acp.acp_v0.models.run_result.RunResult | None)

• oneof_schema_2_validator (agntcy_acp.acp_v0.models.run_interrupt.RunInterrupt | None)

• oneof_schema_3_validator (agntcy_acp.acp_v0.models.run_error.RunError | None)

Validators:

• actual_instance_must_validate_oneof » actual_instance

field actual_instance: RunError | RunInterrupt | RunResult | None = None

Validated by:

• actual_instance_must_validate_oneof

field discriminator_value_class_map: Dict[str, str] = {}

field one_of_schemas: Set[str] = {'RunError', 'RunInterrupt', 'RunResult'}

field oneof_schema_1_validator: RunResult | None = None

field oneof_schema_2_validator: RunInterrupt | None = None

field oneof_schema_3_validator: RunError | None = None

validator actual_instance_must_validate_oneof  »  actual_instance

classmethod from_dict(obj: str | Dict[str, Any]) → Self

classmethod from_json(json_str: str) → Self

Returns the object represented by the json string

to_dict() → Dict[str, Any] | RunError | RunInterrupt | RunResult | None

Returns the dict representation of the actual instance

to_json() → str

Returns the JSON representation of the actual instance

to_str() → str

Returns the string representation of the actual instance

RunOutputStream

pydantic model agntcy_acp.models.RunOutputStream

Server-sent event containing one agent output event. Actual event type is carried inside the data.

Show JSON schema

{
   "title": "RunOutputStream",
   "description": "Server-sent event containing one agent output event. Actual event type is carried inside the data.",
   "type": "object",
   "properties": {
      "id": {
         "description": "Unique identifier of the event",
         "title": "Id",
         "type": "string"
      },
      "event": {
         "description": "Event type. This is the constant string `agent_event` to be compatible with SSE spec. The actual type differentiation is done in the event itself.",
         "title": "Event",
         "type": "string"
      },
      "data": {
         "$ref": "#/$defs/StreamEventPayload"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "CustomRunResultUpdate": {
         "description": "Object holding a custom defined update of the agent result during streaming.",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "run_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the run.",
               "title": "Run Id"
            },
            "status": {
               "$ref": "#/$defs/RunStatus",
               "description": "Status of the Run when this result was generated"
            },
            "update": {
               "description": "An update in the SSE event streaming where streaming mode is set to custom. The schema is described in agent ACP descriptor under 'spec.custom_streaming_update'.",
               "title": "Update",
               "type": "object"
            }
         },
         "required": [
            "type",
            "status",
            "update"
         ],
         "title": "CustomRunResultUpdate",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      },
      "StreamEventPayload": {
         "description": "A serialized JSON data structure carried in the SSE event data field. The event can carry either a full `ValueRunResultUpdate`, if streaming mode is `values` or an `CustomRunResultUpdate` if streaming mode is `custom`",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/ValueRunResultUpdate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CustomRunResultUpdate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/CustomRunResultUpdate"
                  },
                  {
                     "$ref": "#/$defs/ValueRunResultUpdate"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "ValueRunResultUpdate",
                  "CustomRunResultUpdate"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            },
            "discriminator_value_class_map": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Discriminator Value Class Map",
               "type": "object"
            }
         },
         "title": "StreamEventPayload",
         "type": "object"
      },
      "ValueRunResultUpdate": {
         "description": "Partial result provided as value through streaming.",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "run_id": {
               "description": "The ID of the run.",
               "title": "Run Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/RunStatus",
               "description": "Status of the Run when this result was generated. This is particurarly useful when this data structure is used for streaming results. As the server can indicate an interrupt or an error condition while streaming the result."
            },
            "values": {
               "description": "The output of the agent. The schema is described in agent ACP descriptor under 'spec.output'.",
               "title": "Values",
               "type": "object"
            },
            "messages": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Message"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Stream of messages returned by the run.",
               "title": "Messages"
            }
         },
         "required": [
            "type",
            "run_id",
            "status",
            "values"
         ],
         "title": "ValueRunResultUpdate",
         "type": "object"
      }
   },
   "required": [
      "id",
      "event",
      "data"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• data (agntcy_acp.acp_v0.models.stream_event_payload.StreamEventPayload)

• event (str)

• id (str)

Validators:

• event_validate_enum » event

field data: StreamEventPayload [Required]

field event: StrictStr [Required]

Event type. This is the constant string agent_event to be compatible with SSE spec. The actual type differentiation is done in the event itself.

Constraints:

• strict = True

Validated by:

• event_validate_enum

field id: StrictStr [Required]

Unique identifier of the event

Constraints:

• strict = True

validator event_validate_enum  »  event

Validates the enum

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunOutputStream from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunOutputStream from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunResult

pydantic model agntcy_acp.models.RunResult

Final result of a Run.

Show JSON schema

{
   "title": "RunResult",
   "description": "Final result of a Run.",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "type": "string"
      },
      "values": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The output of the agent. The schema is described in agent ACP descriptor under 'spec.output'.",
         "title": "Values"
      },
      "messages": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Message"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The messages returned by the run.",
         "title": "Messages"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      }
   },
   "required": [
      "type"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• messages (List[agntcy_acp.acp_v0.models.message.Message] | None)

• type (str)

• values (Dict[str, Any] | None)

Validators:

• type_validate_enum » type

field messages: List[Message] | None = None

The messages returned by the run.

field type: StrictStr [Required]

Constraints:

• strict = True

Validated by:

• type_validate_enum

field values: Dict[str, Any] | None = None

The output of the agent. The schema is described in agent ACP descriptor under ‘spec.output’.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunResult from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunResult from a JSON string

validator type_validate_enum  »  type

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunSearchRequest

pydantic model agntcy_acp.models.RunSearchRequest

Payload for listing runs.

Show JSON schema

{
   "title": "RunSearchRequest",
   "description": "Payload for listing runs.",
   "type": "object",
   "properties": {
      "agent_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Matches all the Runs associated with the specified Agent ID.",
         "title": "Agent Id"
      },
      "status": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunStatus"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Matches all the Runs associated with the specified status. One of 'pending', 'error', 'success', 'timeout', 'interrupted'."
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Matches all threads for which metadata has  keys and values equal to those specified in this object.",
         "title": "Metadata"
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 1000,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "Maximum number to return.",
         "title": "Limit"
      },
      "offset": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Offset to start from.",
         "title": "Offset"
      }
   },
   "$defs": {
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• agent_id (str | None)

• limit (int | None)

• metadata (Dict[str, Any] | None)

• offset (int | None)

• status (agntcy_acp.acp_v0.models.run_status.RunStatus | None)

field agent_id: StrictStr | None = None

Matches all the Runs associated with the specified Agent ID.

field limit: Annotated[int, Field(le=1000, strict=True, ge=1)] | None = 10

Maximum number to return.

field metadata: Dict[str, Any] | None = None

Matches all threads for which metadata has keys and values equal to those specified in this object.

field offset: Annotated[int, Field(strict=True, ge=0)] | None = 0

Offset to start from.

field status: RunStatus | None = None

Matches all the Runs associated with the specified status. One of ‘pending’, ‘error’, ‘success’, ‘timeout’, ‘interrupted’.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunSearchRequest from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunSearchRequest from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunStateful

pydantic model agntcy_acp.models.RunStateful

Holds all the information of a stateful run

Show JSON schema

{
   "title": "RunStateful",
   "description": "Holds all the information of a stateful run",
   "type": "object",
   "properties": {
      "run_id": {
         "description": "The ID of the run.",
         "title": "Run Id",
         "type": "string"
      },
      "thread_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.",
         "title": "Thread Id"
      },
      "agent_id": {
         "description": "The agent that was used for this run.",
         "title": "Agent Id",
         "type": "string"
      },
      "created_at": {
         "description": "The time the run was created.",
         "format": "date-time",
         "title": "Created At",
         "type": "string"
      },
      "updated_at": {
         "description": "The last time the run was updated.",
         "format": "date-time",
         "title": "Updated At",
         "type": "string"
      },
      "status": {
         "$ref": "#/$defs/RunStatus",
         "description": "The status of the run. One of 'pending', 'error', 'success', 'timeout', 'interrupted'."
      },
      "creation": {
         "$ref": "#/$defs/RunCreateStateful"
      }
   },
   "$defs": {
      "Config": {
         "description": "The configuration for the agent.",
         "properties": {
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "recursion_limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Recursion Limit"
            },
            "configurable": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
               "title": "Configurable"
            }
         },
         "title": "Config",
         "type": "object"
      },
      "RunCreateStateful": {
         "description": "Payload for creating a stateful run.",
         "properties": {
            "agent_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The agent ID to run. If not provided will use the default agent for this service.",
               "title": "Agent Id"
            },
            "input": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The input to the agent. The schema is described in agent ACP descriptor under 'spec.thread_state'.'input'.",
               "title": "Input"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata to assign to the run.",
               "title": "Metadata"
            },
            "config": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Config"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "webhook": {
               "anyOf": [
                  {
                     "maxLength": 65536,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Webhook to call upon change of run status. This is a url that accepts a POST containing the `Run` object as body. See Callbacks definition.",
               "title": "Webhook"
            },
            "stream_mode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "on_disconnect": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "cancel",
               "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.",
               "title": "On Disconnect"
            },
            "multitask_strategy": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "reject",
               "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.",
               "title": "Multitask Strategy"
            },
            "after_seconds": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The number of seconds to wait before starting the run. Use to schedule future runs.",
               "title": "After Seconds"
            },
            "stream_subgraphs": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "Whether to stream output from subgraphs.",
               "title": "Stream Subgraphs"
            },
            "if_not_exists": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "reject",
               "description": "How to handle missing thread. Must be either 'reject' (raise error if missing), or 'create' (create new thread).",
               "title": "If Not Exists"
            }
         },
         "title": "RunCreateStateful",
         "type": "object"
      },
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      },
      "StreamMode": {
         "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/StreamingMode"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Anyof Schema 1 Validator"
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "List[StreamingMode]",
                  "StreamingMode"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "StreamMode",
         "type": "object"
      },
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   },
   "required": [
      "run_id",
      "agent_id",
      "created_at",
      "updated_at",
      "status",
      "creation"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• agent_id (str)

• created_at (datetime.datetime)

• creation (agntcy_acp.acp_v0.models.run_create_stateful.RunCreateStateful)

• run_id (str)

• status (agntcy_acp.acp_v0.models.run_status.RunStatus)

• thread_id (str | None)

• updated_at (datetime.datetime)

field agent_id: StrictStr [Required]

The agent that was used for this run.

Constraints:

• strict = True

field created_at: datetime [Required]

The time the run was created.

field creation: RunCreateStateful [Required]

field run_id: StrictStr [Required]

The ID of the run.

Constraints:

• strict = True

field status: RunStatus [Required]

The status of the run. One of ‘pending’, ‘error’, ‘success’, ‘timeout’, ‘interrupted’.

field thread_id: StrictStr | None = None

Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.

field updated_at: datetime [Required]

The last time the run was updated.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunStateful from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunStateful from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunStateless

pydantic model agntcy_acp.models.RunStateless

Holds all the information of a stateless run

Show JSON schema

{
   "title": "RunStateless",
   "description": "Holds all the information of a stateless run",
   "type": "object",
   "properties": {
      "run_id": {
         "description": "The ID of the run.",
         "title": "Run Id",
         "type": "string"
      },
      "thread_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.",
         "title": "Thread Id"
      },
      "agent_id": {
         "description": "The agent that was used for this run.",
         "title": "Agent Id",
         "type": "string"
      },
      "created_at": {
         "description": "The time the run was created.",
         "format": "date-time",
         "title": "Created At",
         "type": "string"
      },
      "updated_at": {
         "description": "The last time the run was updated.",
         "format": "date-time",
         "title": "Updated At",
         "type": "string"
      },
      "status": {
         "$ref": "#/$defs/RunStatus",
         "description": "The status of the run. One of 'pending', 'error', 'success', 'timeout', 'interrupted'."
      },
      "creation": {
         "$ref": "#/$defs/RunCreateStateless"
      }
   },
   "$defs": {
      "Config": {
         "description": "The configuration for the agent.",
         "properties": {
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "recursion_limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Recursion Limit"
            },
            "configurable": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
               "title": "Configurable"
            }
         },
         "title": "Config",
         "type": "object"
      },
      "RunCreateStateless": {
         "description": "Payload for creating a stateless run.",
         "properties": {
            "agent_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The agent ID to run. If not provided will use the default agent for this service.",
               "title": "Agent Id"
            },
            "input": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The input to the agent. The schema is described in agent ACP descriptor under 'spec.thread_state'.'input'.",
               "title": "Input"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata to assign to the run.",
               "title": "Metadata"
            },
            "config": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Config"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "webhook": {
               "anyOf": [
                  {
                     "maxLength": 65536,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Webhook to call upon change of run status. This is a url that accepts a POST containing the `Run` object as body. See Callbacks definition.",
               "title": "Webhook"
            },
            "stream_mode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "on_disconnect": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "cancel",
               "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.",
               "title": "On Disconnect"
            },
            "multitask_strategy": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "reject",
               "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.",
               "title": "Multitask Strategy"
            },
            "after_seconds": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The number of seconds to wait before starting the run. Use to schedule future runs.",
               "title": "After Seconds"
            },
            "on_completion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "delete",
               "description": "Whether to delete or keep the thread created for a stateless run. Must be one of 'delete' or 'keep'.",
               "title": "On Completion"
            }
         },
         "title": "RunCreateStateless",
         "type": "object"
      },
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      },
      "StreamMode": {
         "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/StreamingMode"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Anyof Schema 1 Validator"
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "List[StreamingMode]",
                  "StreamingMode"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "StreamMode",
         "type": "object"
      },
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   },
   "required": [
      "run_id",
      "agent_id",
      "created_at",
      "updated_at",
      "status",
      "creation"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• agent_id (str)

• created_at (datetime.datetime)

• creation (agntcy_acp.acp_v0.models.run_create_stateless.RunCreateStateless)

• run_id (str)

• status (agntcy_acp.acp_v0.models.run_status.RunStatus)

• thread_id (str | None)

• updated_at (datetime.datetime)

field agent_id: StrictStr [Required]

The agent that was used for this run.

Constraints:

• strict = True

field created_at: datetime [Required]

The time the run was created.

field creation: RunCreateStateless [Required]

field run_id: StrictStr [Required]

The ID of the run.

Constraints:

• strict = True

field status: RunStatus [Required]

The status of the run. One of ‘pending’, ‘error’, ‘success’, ‘timeout’, ‘interrupted’.

field thread_id: StrictStr | None = None

Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.

field updated_at: datetime [Required]

The last time the run was updated.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunStateless from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunStateless from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunStatus

class agntcy_acp.models.RunStatus(*values)

classmethod from_json(json_str: str) → Self

Create an instance of RunStatus from a JSON string

RunWaitResponseStateful

pydantic model agntcy_acp.models.RunWaitResponseStateful

RunWaitResponseStateful

Show JSON schema

{
   "title": "RunWaitResponseStateful",
   "description": "RunWaitResponseStateful",
   "type": "object",
   "properties": {
      "run": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunStateful"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The run information."
      },
      "output": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunOutput"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "Config": {
         "description": "The configuration for the agent.",
         "properties": {
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "recursion_limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Recursion Limit"
            },
            "configurable": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
               "title": "Configurable"
            }
         },
         "title": "Config",
         "type": "object"
      },
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "RunCreateStateful": {
         "description": "Payload for creating a stateful run.",
         "properties": {
            "agent_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The agent ID to run. If not provided will use the default agent for this service.",
               "title": "Agent Id"
            },
            "input": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The input to the agent. The schema is described in agent ACP descriptor under 'spec.thread_state'.'input'.",
               "title": "Input"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata to assign to the run.",
               "title": "Metadata"
            },
            "config": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Config"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "webhook": {
               "anyOf": [
                  {
                     "maxLength": 65536,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Webhook to call upon change of run status. This is a url that accepts a POST containing the `Run` object as body. See Callbacks definition.",
               "title": "Webhook"
            },
            "stream_mode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "on_disconnect": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "cancel",
               "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.",
               "title": "On Disconnect"
            },
            "multitask_strategy": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "reject",
               "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.",
               "title": "Multitask Strategy"
            },
            "after_seconds": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The number of seconds to wait before starting the run. Use to schedule future runs.",
               "title": "After Seconds"
            },
            "stream_subgraphs": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "Whether to stream output from subgraphs.",
               "title": "Stream Subgraphs"
            },
            "if_not_exists": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "reject",
               "description": "How to handle missing thread. Must be either 'reject' (raise error if missing), or 'create' (create new thread).",
               "title": "If Not Exists"
            }
         },
         "title": "RunCreateStateful",
         "type": "object"
      },
      "RunError": {
         "description": "Run terminated with an error",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "run_id": {
               "description": "The ID of the run.",
               "title": "Run Id",
               "type": "string"
            },
            "errcode": {
               "description": "code of the error",
               "title": "Errcode",
               "type": "integer"
            },
            "description": {
               "description": "description of the error",
               "title": "Description",
               "type": "string"
            }
         },
         "required": [
            "type",
            "run_id",
            "errcode",
            "description"
         ],
         "title": "RunError",
         "type": "object"
      },
      "RunInterrupt": {
         "description": "Interrupt occurred during a Run",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "interrupt": {
               "description": "This schema describes the interrupt payload. Actual schema describes a polimorphic object, which means a schema structured with `oneOf` and `discriminator`. The discriminator is the `interrupt_type`, while the schemas will be the ones defined in the agent spec under `interrupts`/`interrupt_payload` For example:          oneOf:   - $ref: '#/components/schemas/ApprovalInterruptPayload'   - $ref: '#/components/schemas/QuestionInterruptPayload' discriminator:   propertyName: interruput_type   mapping:     approval: '#/components/schemas/ApprovalInterruptPayload'     question: '#/components/schemas/QuestionInterruptPayload'",
               "title": "Interrupt",
               "type": "object"
            }
         },
         "required": [
            "type",
            "interrupt"
         ],
         "title": "RunInterrupt",
         "type": "object"
      },
      "RunOutput": {
         "description": "Output of a Run. Can be the final result or an interrupt.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunInterrupt"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oneof_schema_3_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunError"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunError"
                  },
                  {
                     "$ref": "#/$defs/RunInterrupt"
                  },
                  {
                     "$ref": "#/$defs/RunResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "RunResult",
                  "RunError",
                  "RunInterrupt"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            },
            "discriminator_value_class_map": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Discriminator Value Class Map",
               "type": "object"
            }
         },
         "title": "RunOutput",
         "type": "object"
      },
      "RunResult": {
         "description": "Final result of a Run.",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "values": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The output of the agent. The schema is described in agent ACP descriptor under 'spec.output'.",
               "title": "Values"
            },
            "messages": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Message"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The messages returned by the run.",
               "title": "Messages"
            }
         },
         "required": [
            "type"
         ],
         "title": "RunResult",
         "type": "object"
      },
      "RunStateful": {
         "description": "Holds all the information of a stateful run",
         "properties": {
            "run_id": {
               "description": "The ID of the run.",
               "title": "Run Id",
               "type": "string"
            },
            "thread_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.",
               "title": "Thread Id"
            },
            "agent_id": {
               "description": "The agent that was used for this run.",
               "title": "Agent Id",
               "type": "string"
            },
            "created_at": {
               "description": "The time the run was created.",
               "format": "date-time",
               "title": "Created At",
               "type": "string"
            },
            "updated_at": {
               "description": "The last time the run was updated.",
               "format": "date-time",
               "title": "Updated At",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/RunStatus",
               "description": "The status of the run. One of 'pending', 'error', 'success', 'timeout', 'interrupted'."
            },
            "creation": {
               "$ref": "#/$defs/RunCreateStateful"
            }
         },
         "required": [
            "run_id",
            "agent_id",
            "created_at",
            "updated_at",
            "status",
            "creation"
         ],
         "title": "RunStateful",
         "type": "object"
      },
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      },
      "StreamMode": {
         "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/StreamingMode"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Anyof Schema 1 Validator"
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "List[StreamingMode]",
                  "StreamingMode"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "StreamMode",
         "type": "object"
      },
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• output (agntcy_acp.acp_v0.models.run_output.RunOutput | None)

• run (agntcy_acp.acp_v0.models.run_stateful.RunStateful | None)

field output: RunOutput | None = None

field run: RunStateful | None = None

The run information.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunWaitResponseStateful from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunWaitResponseStateful from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

RunWaitResponseStateless

pydantic model agntcy_acp.models.RunWaitResponseStateless

RunWaitResponseStateless

Show JSON schema

{
   "title": "RunWaitResponseStateless",
   "description": "RunWaitResponseStateless",
   "type": "object",
   "properties": {
      "run": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunStateless"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The run information."
      },
      "output": {
         "anyOf": [
            {
               "$ref": "#/$defs/RunOutput"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "Config": {
         "description": "The configuration for the agent.",
         "properties": {
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "recursion_limit": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Recursion Limit"
            },
            "configurable": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The configuration for this agent. The schema is described in agent ACP descriptor under 'spec.config'. If missing, default values are used.",
               "title": "Configurable"
            }
         },
         "title": "Config",
         "type": "object"
      },
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "RunCreateStateless": {
         "description": "Payload for creating a stateless run.",
         "properties": {
            "agent_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The agent ID to run. If not provided will use the default agent for this service.",
               "title": "Agent Id"
            },
            "input": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The input to the agent. The schema is described in agent ACP descriptor under 'spec.thread_state'.'input'.",
               "title": "Input"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Metadata to assign to the run.",
               "title": "Metadata"
            },
            "config": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Config"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "webhook": {
               "anyOf": [
                  {
                     "maxLength": 65536,
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Webhook to call upon change of run status. This is a url that accepts a POST containing the `Run` object as body. See Callbacks definition.",
               "title": "Webhook"
            },
            "stream_mode": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "on_disconnect": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "cancel",
               "description": "The disconnect mode to use. Must be one of 'cancel' or 'continue'.",
               "title": "On Disconnect"
            },
            "multitask_strategy": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "reject",
               "description": "Multitask strategy to use. Must be one of 'reject', 'interrupt', 'rollback', or 'enqueue'.",
               "title": "Multitask Strategy"
            },
            "after_seconds": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The number of seconds to wait before starting the run. Use to schedule future runs.",
               "title": "After Seconds"
            },
            "on_completion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "delete",
               "description": "Whether to delete or keep the thread created for a stateless run. Must be one of 'delete' or 'keep'.",
               "title": "On Completion"
            }
         },
         "title": "RunCreateStateless",
         "type": "object"
      },
      "RunError": {
         "description": "Run terminated with an error",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "run_id": {
               "description": "The ID of the run.",
               "title": "Run Id",
               "type": "string"
            },
            "errcode": {
               "description": "code of the error",
               "title": "Errcode",
               "type": "integer"
            },
            "description": {
               "description": "description of the error",
               "title": "Description",
               "type": "string"
            }
         },
         "required": [
            "type",
            "run_id",
            "errcode",
            "description"
         ],
         "title": "RunError",
         "type": "object"
      },
      "RunInterrupt": {
         "description": "Interrupt occurred during a Run",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "interrupt": {
               "description": "This schema describes the interrupt payload. Actual schema describes a polimorphic object, which means a schema structured with `oneOf` and `discriminator`. The discriminator is the `interrupt_type`, while the schemas will be the ones defined in the agent spec under `interrupts`/`interrupt_payload` For example:          oneOf:   - $ref: '#/components/schemas/ApprovalInterruptPayload'   - $ref: '#/components/schemas/QuestionInterruptPayload' discriminator:   propertyName: interruput_type   mapping:     approval: '#/components/schemas/ApprovalInterruptPayload'     question: '#/components/schemas/QuestionInterruptPayload'",
               "title": "Interrupt",
               "type": "object"
            }
         },
         "required": [
            "type",
            "interrupt"
         ],
         "title": "RunInterrupt",
         "type": "object"
      },
      "RunOutput": {
         "description": "Output of a Run. Can be the final result or an interrupt.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunInterrupt"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "oneof_schema_3_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunError"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RunError"
                  },
                  {
                     "$ref": "#/$defs/RunInterrupt"
                  },
                  {
                     "$ref": "#/$defs/RunResult"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "RunResult",
                  "RunError",
                  "RunInterrupt"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            },
            "discriminator_value_class_map": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Discriminator Value Class Map",
               "type": "object"
            }
         },
         "title": "RunOutput",
         "type": "object"
      },
      "RunResult": {
         "description": "Final result of a Run.",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "values": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The output of the agent. The schema is described in agent ACP descriptor under 'spec.output'.",
               "title": "Values"
            },
            "messages": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Message"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The messages returned by the run.",
               "title": "Messages"
            }
         },
         "required": [
            "type"
         ],
         "title": "RunResult",
         "type": "object"
      },
      "RunStateless": {
         "description": "Holds all the information of a stateless run",
         "properties": {
            "run_id": {
               "description": "The ID of the run.",
               "title": "Run Id",
               "type": "string"
            },
            "thread_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional Thread ID wher the Run belongs to. This is populated only for runs on agents agents supporting Threads.",
               "title": "Thread Id"
            },
            "agent_id": {
               "description": "The agent that was used for this run.",
               "title": "Agent Id",
               "type": "string"
            },
            "created_at": {
               "description": "The time the run was created.",
               "format": "date-time",
               "title": "Created At",
               "type": "string"
            },
            "updated_at": {
               "description": "The last time the run was updated.",
               "format": "date-time",
               "title": "Updated At",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/RunStatus",
               "description": "The status of the run. One of 'pending', 'error', 'success', 'timeout', 'interrupted'."
            },
            "creation": {
               "$ref": "#/$defs/RunCreateStateless"
            }
         },
         "required": [
            "run_id",
            "agent_id",
            "created_at",
            "updated_at",
            "status",
            "creation"
         ],
         "title": "RunStateless",
         "type": "object"
      },
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      },
      "StreamMode": {
         "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/StreamingMode"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Anyof Schema 1 Validator"
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/StreamingMode"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "List[StreamingMode]",
                  "StreamingMode"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "StreamMode",
         "type": "object"
      },
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• output (agntcy_acp.acp_v0.models.run_output.RunOutput | None)

• run (agntcy_acp.acp_v0.models.run_stateless.RunStateless | None)

field output: RunOutput | None = None

field run: RunStateless | None = None

The run information.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of RunWaitResponseStateless from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of RunWaitResponseStateless from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

StreamEventPayload

pydantic model agntcy_acp.models.StreamEventPayload

A serialized JSON data structure carried in the SSE event data field. The event can carry either a full ValueRunResultUpdate, if streaming mode is values or an CustomRunResultUpdate if streaming mode is custom

Show JSON schema

{
   "title": "StreamEventPayload",
   "description": "A serialized JSON data structure carried in the SSE event data field. The event can carry either a full `ValueRunResultUpdate`, if streaming mode is `values` or an `CustomRunResultUpdate` if streaming mode is `custom`",
   "type": "object",
   "properties": {
      "oneof_schema_1_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/ValueRunResultUpdate"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "oneof_schema_2_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/CustomRunResultUpdate"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "actual_instance": {
         "anyOf": [
            {
               "$ref": "#/$defs/CustomRunResultUpdate"
            },
            {
               "$ref": "#/$defs/ValueRunResultUpdate"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Actual Instance"
      },
      "one_of_schemas": {
         "default": [
            "ValueRunResultUpdate",
            "CustomRunResultUpdate"
         ],
         "items": {
            "type": "string"
         },
         "title": "One Of Schemas",
         "type": "array",
         "uniqueItems": true
      },
      "discriminator_value_class_map": {
         "additionalProperties": {
            "type": "string"
         },
         "default": {},
         "title": "Discriminator Value Class Map",
         "type": "object"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "CustomRunResultUpdate": {
         "description": "Object holding a custom defined update of the agent result during streaming.",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "run_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the run.",
               "title": "Run Id"
            },
            "status": {
               "$ref": "#/$defs/RunStatus",
               "description": "Status of the Run when this result was generated"
            },
            "update": {
               "description": "An update in the SSE event streaming where streaming mode is set to custom. The schema is described in agent ACP descriptor under 'spec.custom_streaming_update'.",
               "title": "Update",
               "type": "object"
            }
         },
         "required": [
            "type",
            "status",
            "update"
         ],
         "title": "CustomRunResultUpdate",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      },
      "ValueRunResultUpdate": {
         "description": "Partial result provided as value through streaming.",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "run_id": {
               "description": "The ID of the run.",
               "title": "Run Id",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/RunStatus",
               "description": "Status of the Run when this result was generated. This is particurarly useful when this data structure is used for streaming results. As the server can indicate an interrupt or an error condition while streaming the result."
            },
            "values": {
               "description": "The output of the agent. The schema is described in agent ACP descriptor under 'spec.output'.",
               "title": "Values",
               "type": "object"
            },
            "messages": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Message"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Stream of messages returned by the run.",
               "title": "Messages"
            }
         },
         "required": [
            "type",
            "run_id",
            "status",
            "values"
         ],
         "title": "ValueRunResultUpdate",
         "type": "object"
      }
   }
}

Config:

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• actual_instance (agntcy_acp.acp_v0.models.custom_run_result_update.CustomRunResultUpdate | agntcy_acp.acp_v0.models.value_run_result_update.ValueRunResultUpdate | None)

• discriminator_value_class_map (Dict[str, str])

• one_of_schemas (Set[str])

• oneof_schema_1_validator (agntcy_acp.acp_v0.models.value_run_result_update.ValueRunResultUpdate | None)

• oneof_schema_2_validator (agntcy_acp.acp_v0.models.custom_run_result_update.CustomRunResultUpdate | None)

Validators:

• actual_instance_must_validate_oneof » actual_instance

field actual_instance: CustomRunResultUpdate | ValueRunResultUpdate | None = None

Validated by:

• actual_instance_must_validate_oneof

field discriminator_value_class_map: Dict[str, str] = {}

field one_of_schemas: Set[str] = {'CustomRunResultUpdate', 'ValueRunResultUpdate'}

field oneof_schema_1_validator: ValueRunResultUpdate | None = None

field oneof_schema_2_validator: CustomRunResultUpdate | None = None

validator actual_instance_must_validate_oneof  »  actual_instance

classmethod from_dict(obj: str | Dict[str, Any]) → Self

classmethod from_json(json_str: str) → Self

Returns the object represented by the json string

to_dict() → Dict[str, Any] | CustomRunResultUpdate | ValueRunResultUpdate | None

Returns the dict representation of the actual instance

to_json() → str

Returns the JSON representation of the actual instance

to_str() → str

Returns the string representation of the actual instance

StreamMode

pydantic model agntcy_acp.models.StreamMode

If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor under specs.capabilities

Show JSON schema

{
   "title": "StreamMode",
   "description": "If populated, indicates that the client requests to stream results with the specified streaming mode(s). The requested streaming mode(s) must be one or more of those supported by the agent as declared in agent ACP descriptor  under `specs.capabilities`",
   "type": "object",
   "properties": {
      "anyof_schema_1_validator": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/StreamingMode"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Anyof Schema 1 Validator"
      },
      "anyof_schema_2_validator": {
         "anyOf": [
            {
               "$ref": "#/$defs/StreamingMode"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "actual_instance": {
         "default": null,
         "title": "Actual Instance"
      },
      "any_of_schemas": {
         "default": [
            "List[StreamingMode]",
            "StreamingMode"
         ],
         "items": {
            "type": "string"
         },
         "title": "Any Of Schemas",
         "type": "array",
         "uniqueItems": true
      }
   },
   "$defs": {
      "StreamingMode": {
         "description": "StreamingMode",
         "enum": [
            "values",
            "custom"
         ],
         "title": "StreamingMode",
         "type": "string"
      }
   }
}

Config:

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• actual_instance (Any)

• any_of_schemas (Set[str])

• anyof_schema_1_validator (List[agntcy_acp.acp_v0.models.streaming_mode.StreamingMode] | None)

• anyof_schema_2_validator (agntcy_acp.acp_v0.models.streaming_mode.StreamingMode | None)

Validators:

• actual_instance_must_validate_anyof » actual_instance

field actual_instance: Any = None

Validated by:

• actual_instance_must_validate_anyof

field any_of_schemas: Set[str] = {'List[StreamingMode]', 'StreamingMode'}

field anyof_schema_1_validator: List[StreamingMode] | None = None

field anyof_schema_2_validator: StreamingMode | None = None

validator actual_instance_must_validate_anyof  »  actual_instance

classmethod from_dict(obj: Dict[str, Any]) → Self

classmethod from_json(json_str: str) → Self

Returns the object represented by the json string

to_dict() → Dict[str, Any] | List[StreamingMode] | StreamingMode | None

Returns the dict representation of the actual instance

to_json() → str

Returns the JSON representation of the actual instance

to_str() → str

Returns the string representation of the actual instance

StreamingMode

class agntcy_acp.models.StreamingMode(*values)

classmethod from_json(json_str: str) → Self

Create an instance of StreamingMode from a JSON string

StreamingModes

pydantic model agntcy_acp.models.StreamingModes

Supported streaming modes. If missing, streaming is not supported. If no mode is supported attempts to stream output will result in an error.

Show JSON schema

{
   "title": "StreamingModes",
   "description": "Supported streaming modes. If missing, streaming is not supported.  If no mode is supported attempts to stream output will result in an error.",
   "type": "object",
   "properties": {
      "values": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is `true` if the agent supports values streaming. If `false` or missing, values streaming is not supported. Values streaming consists of a stream of objects of type `ValueRunResultUpdate`, where each one sent over the stream fully replace the previous one.",
         "title": "Values"
      },
      "custom": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "This is `true` if the agent supports custom objects streaming. If `false` or missing, custom streaming is not supported. Custom Objects streaming consists of a stream of object whose schema is specified by the agent ACP descriptor under `specs.custom_streaming_update`.",
         "title": "Custom"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• custom (bool | None)

• values (bool | None)

field custom: StrictBool | None = None

This is true if the agent supports custom objects streaming. If false or missing, custom streaming is not supported. Custom Objects streaming consists of a stream of object whose schema is specified by the agent ACP descriptor under specs.custom_streaming_update.

field values: StrictBool | None = None

This is true if the agent supports values streaming. If false or missing, values streaming is not supported. Values streaming consists of a stream of objects of type ValueRunResultUpdate, where each one sent over the stream fully replace the previous one.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of StreamingModes from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of StreamingModes from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

Thread

pydantic model agntcy_acp.models.Thread

Represents a collection of consecutive runs over a thread. Thread is associated with a state. Runs for a thread can potentially happen across different agents, if the state format is compatible.

Show JSON schema

{
   "title": "Thread",
   "description": "Represents a collection of consecutive runs over a thread.  Thread is associated with a state. Runs for a thread can potentially happen across different agents, if the state format is compatible.",
   "type": "object",
   "properties": {
      "thread_id": {
         "description": "unique identifier of a thread",
         "title": "Thread Id",
         "type": "string"
      },
      "created_at": {
         "description": "The time the thread was created.",
         "format": "date-time",
         "title": "Created At",
         "type": "string"
      },
      "updated_at": {
         "description": "The last time the thread was updated.",
         "format": "date-time",
         "title": "Updated At",
         "type": "string"
      },
      "metadata": {
         "description": "Free form metadata for this thread",
         "title": "Metadata",
         "type": "object"
      },
      "status": {
         "description": "The status of the thread.",
         "title": "Status",
         "type": "string"
      },
      "values": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The thread state. The schema is described in agent ACP descriptor under 'spec.thread_state'.",
         "title": "Values"
      },
      "messages": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Message"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The current Messages of the thread. If messages are contained in Thread.values, implementations should remove them from values when returning messages. When this key isn't present it means the thread/agent doesn't support messages.",
         "title": "Messages"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      }
   },
   "required": [
      "thread_id",
      "created_at",
      "updated_at",
      "metadata",
      "status"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• created_at (datetime.datetime)

• messages (List[agntcy_acp.acp_v0.models.message.Message] | None)

• metadata (Dict[str, Any])

• status (str)

• thread_id (str)

• updated_at (datetime.datetime)

• values (Dict[str, Any] | None)

Validators:

• status_validate_enum » status

field created_at: datetime [Required]

The time the thread was created.

field messages: List[Message] | None = None

The current Messages of the thread. If messages are contained in Thread.values, implementations should remove them from values when returning messages. When this key isn’t present it means the thread/agent doesn’t support messages.

field metadata: Dict[str, Any] [Required]

Free form metadata for this thread

field status: StrictStr [Required]

The status of the thread.

Constraints:

• strict = True

Validated by:

• status_validate_enum

field thread_id: StrictStr [Required]

unique identifier of a thread

Constraints:

• strict = True

field updated_at: datetime [Required]

The last time the thread was updated.

field values: Dict[str, Any] | None = None

The thread state. The schema is described in agent ACP descriptor under ‘spec.thread_state’.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of Thread from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of Thread from a JSON string

validator status_validate_enum  »  status

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

ThreadCheckpoint

pydantic model agntcy_acp.models.ThreadCheckpoint

Structured identifier for a thread checkpoint, ie. an entry in the thread’s history.

Show JSON schema

{
   "title": "ThreadCheckpoint",
   "description": "Structured identifier for a thread checkpoint, ie. an entry in the thread's history.",
   "type": "object",
   "properties": {
      "checkpoint_id": {
         "description": "The ID of the checkpoint.",
         "title": "Checkpoint Id",
         "type": "string"
      }
   },
   "required": [
      "checkpoint_id"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• checkpoint_id (str)

field checkpoint_id: StrictStr [Required]

The ID of the checkpoint.

Constraints:

• strict = True

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of ThreadCheckpoint from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of ThreadCheckpoint from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

ThreadCreate

pydantic model agntcy_acp.models.ThreadCreate

Detail of an empty thread to be created.

Show JSON schema

{
   "title": "ThreadCreate",
   "description": "Detail of an empty thread to be created.",
   "type": "object",
   "properties": {
      "thread_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The ID of the thread. If not provided, a random UUID will be generated.",
         "title": "Thread Id"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Free form metadata for this thread",
         "title": "Metadata"
      },
      "if_exists": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "raise",
         "description": "How to handle duplicate creation. Must be either 'raise' (raise error if duplicate), or 'do_nothing' (return existing thread).",
         "title": "If Exists"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• if_exists (str | None)

• metadata (Dict[str, Any] | None)

• thread_id (str | None)

Validators:

• if_exists_validate_enum » if_exists

field if_exists: StrictStr | None = 'raise'

How to handle duplicate creation. Must be either ‘raise’ (raise error if duplicate), or ‘do_nothing’ (return existing thread).

Validated by:

• if_exists_validate_enum

field metadata: Dict[str, Any] | None = None

Free form metadata for this thread

field thread_id: StrictStr | None = None

The ID of the thread. If not provided, a random UUID will be generated.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of ThreadCreate from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of ThreadCreate from a JSON string

validator if_exists_validate_enum  »  if_exists

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

ThreadPatch

pydantic model agntcy_acp.models.ThreadPatch

Payload for updating a thread.

Show JSON schema

{
   "title": "ThreadPatch",
   "description": "Payload for updating a thread.",
   "type": "object",
   "properties": {
      "checkpoint": {
         "anyOf": [
            {
               "$ref": "#/$defs/ThreadCheckpoint"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The identifier of the checkpoint to branch from. Ignored for metadata-only patches. If not provided, defaults to the latest checkpoint."
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Metadata to merge with existing thread metadata.",
         "title": "Metadata"
      },
      "values": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The thread state. The schema is described in agent ACP descriptor under 'spec.thread_state'.",
         "title": "Values"
      },
      "messages": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Message"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The current Messages of the thread. If messages are contained in Thread.values, implementations should remove them from values when returning messages. When this key isn't present it means the thread/agent doesn't support messages.",
         "title": "Messages"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "ThreadCheckpoint": {
         "description": "Structured identifier for a thread checkpoint, ie. an entry in the thread's history.",
         "properties": {
            "checkpoint_id": {
               "description": "The ID of the checkpoint.",
               "title": "Checkpoint Id",
               "type": "string"
            }
         },
         "required": [
            "checkpoint_id"
         ],
         "title": "ThreadCheckpoint",
         "type": "object"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• checkpoint (agntcy_acp.acp_v0.models.thread_checkpoint.ThreadCheckpoint | None)

• messages (List[agntcy_acp.acp_v0.models.message.Message] | None)

• metadata (Dict[str, Any] | None)

• values (Dict[str, Any] | None)

field checkpoint: ThreadCheckpoint | None = None

The identifier of the checkpoint to branch from. Ignored for metadata-only patches. If not provided, defaults to the latest checkpoint.

field messages: List[Message] | None = None

The current Messages of the thread. If messages are contained in Thread.values, implementations should remove them from values when returning messages. When this key isn’t present it means the thread/agent doesn’t support messages.

field metadata: Dict[str, Any] | None = None

Metadata to merge with existing thread metadata.

field values: Dict[str, Any] | None = None

The thread state. The schema is described in agent ACP descriptor under ‘spec.thread_state’.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of ThreadPatch from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of ThreadPatch from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

ThreadSearchRequest

pydantic model agntcy_acp.models.ThreadSearchRequest

Payload for listing threads.

Show JSON schema

{
   "title": "ThreadSearchRequest",
   "description": "Payload for listing threads.",
   "type": "object",
   "properties": {
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Matches all threads for which metadata has  keys and values equal to those specified in this object.",
         "title": "Metadata"
      },
      "values": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "State values to filter on.",
         "title": "Values"
      },
      "status": {
         "anyOf": [
            {
               "$ref": "#/$defs/ThreadStatus"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "limit": {
         "anyOf": [
            {
               "maximum": 1000,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "Maximum number to return.",
         "title": "Limit"
      },
      "offset": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Offset to start from.",
         "title": "Offset"
      }
   },
   "$defs": {
      "ThreadStatus": {
         "description": "ThreadStatus",
         "enum": [
            "idle",
            "busy",
            "interrupted",
            "error"
         ],
         "title": "ThreadStatus",
         "type": "string"
      }
   }
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• limit (int | None)

• metadata (Dict[str, Any] | None)

• offset (int | None)

• status (agntcy_acp.acp_v0.models.thread_status.ThreadStatus | None)

• values (Dict[str, Any] | None)

field limit: Annotated[int, Field(le=1000, strict=True, ge=1)] | None = 10

Maximum number to return.

field metadata: Dict[str, Any] | None = None

Matches all threads for which metadata has keys and values equal to those specified in this object.

field offset: Annotated[int, Field(strict=True, ge=0)] | None = 0

Offset to start from.

field status: ThreadStatus | None = None

field values: Dict[str, Any] | None = None

State values to filter on.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of ThreadSearchRequest from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of ThreadSearchRequest from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

ThreadState

pydantic model agntcy_acp.models.ThreadState

ThreadState

Show JSON schema

{
   "title": "ThreadState",
   "description": "ThreadState",
   "type": "object",
   "properties": {
      "checkpoint": {
         "$ref": "#/$defs/ThreadCheckpoint",
         "description": "The identifier for this checkpoint."
      },
      "values": {
         "description": "The thread state. The schema is described in agent ACP descriptor under 'spec.thread_state'.",
         "title": "Values",
         "type": "object"
      },
      "messages": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Message"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The current messages of the thread. If messages are contained in Thread.values, implementations should remove them from values when returning messages. When this key isn't present it means the thread/agent doesn't support messages.",
         "title": "Messages"
      },
      "metadata": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The checkpoint metadata.",
         "title": "Metadata"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "ThreadCheckpoint": {
         "description": "Structured identifier for a thread checkpoint, ie. an entry in the thread's history.",
         "properties": {
            "checkpoint_id": {
               "description": "The ID of the checkpoint.",
               "title": "Checkpoint Id",
               "type": "string"
            }
         },
         "required": [
            "checkpoint_id"
         ],
         "title": "ThreadCheckpoint",
         "type": "object"
      }
   },
   "required": [
      "checkpoint",
      "values"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• checkpoint (agntcy_acp.acp_v0.models.thread_checkpoint.ThreadCheckpoint)

• messages (List[agntcy_acp.acp_v0.models.message.Message] | None)

• metadata (Dict[str, Any] | None)

• values (Dict[str, Any])

field checkpoint: ThreadCheckpoint [Required]

The identifier for this checkpoint.

field messages: List[Message] | None = None

The current messages of the thread. If messages are contained in Thread.values, implementations should remove them from values when returning messages. When this key isn’t present it means the thread/agent doesn’t support messages.

field metadata: Dict[str, Any] | None = None

The checkpoint metadata.

field values: Dict[str, Any] [Required]

The thread state. The schema is described in agent ACP descriptor under ‘spec.thread_state’.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of ThreadState from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of ThreadState from a JSON string

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias

ThreadStatus

class agntcy_acp.models.ThreadStatus(*values)

classmethod from_json(json_str: str) → Self

Create an instance of ThreadStatus from a JSON string

ValueRunResultUpdate

pydantic model agntcy_acp.models.ValueRunResultUpdate

Partial result provided as value through streaming.

Show JSON schema

{
   "title": "ValueRunResultUpdate",
   "description": "Partial result provided as value through streaming.",
   "type": "object",
   "properties": {
      "type": {
         "title": "Type",
         "type": "string"
      },
      "run_id": {
         "description": "The ID of the run.",
         "title": "Run Id",
         "type": "string"
      },
      "status": {
         "$ref": "#/$defs/RunStatus",
         "description": "Status of the Run when this result was generated. This is particurarly useful when this data structure is used for streaming results. As the server can indicate an interrupt or an error condition while streaming the result."
      },
      "values": {
         "description": "The output of the agent. The schema is described in agent ACP descriptor under 'spec.output'.",
         "title": "Values",
         "type": "object"
      },
      "messages": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Message"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Stream of messages returned by the run.",
         "title": "Messages"
      }
   },
   "$defs": {
      "Content": {
         "description": "The content of the message.",
         "properties": {
            "oneof_schema_1_validator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 1 Validator"
            },
            "oneof_schema_2_validator": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Oneof Schema 2 Validator"
            },
            "actual_instance": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ContentOneOfInner"
                     },
                     "type": "array"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Actual Instance"
            },
            "one_of_schemas": {
               "default": [
                  "List[ContentOneOfInner]",
                  "str"
               ],
               "items": {
                  "type": "string"
               },
               "title": "One Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "Content",
         "type": "object"
      },
      "ContentOneOfInner": {
         "description": "ContentOneOfInner",
         "properties": {
            "anyof_schema_1_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageTextBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "anyof_schema_2_validator": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MessageAnyBlock"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "actual_instance": {
               "default": null,
               "title": "Actual Instance"
            },
            "any_of_schemas": {
               "default": [
                  "MessageTextBlock",
                  "MessageAnyBlock"
               ],
               "items": {
                  "type": "string"
               },
               "title": "Any Of Schemas",
               "type": "array",
               "uniqueItems": true
            }
         },
         "title": "ContentOneOfInner",
         "type": "object"
      },
      "Message": {
         "description": "Message",
         "properties": {
            "role": {
               "description": "The role of the message.",
               "title": "Role",
               "type": "string"
            },
            "content": {
               "$ref": "#/$defs/Content"
            },
            "id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The ID of the message.",
               "title": "Id"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The metadata of the message.",
               "title": "Metadata"
            }
         },
         "required": [
            "role",
            "content"
         ],
         "title": "Message",
         "type": "object"
      },
      "MessageAnyBlock": {
         "description": "MessageAnyBlock",
         "properties": {
            "type": {
               "title": "Type",
               "type": "string"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "type"
         ],
         "title": "MessageAnyBlock",
         "type": "object"
      },
      "MessageTextBlock": {
         "description": "MessageTextBlock",
         "properties": {
            "text": {
               "title": "Text",
               "type": "string"
            },
            "type": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "title": "Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "text",
            "type"
         ],
         "title": "MessageTextBlock",
         "type": "object"
      },
      "RunStatus": {
         "description": "RunStatus",
         "enum": [
            "pending",
            "error",
            "success",
            "timeout",
            "interrupted"
         ],
         "title": "RunStatus",
         "type": "string"
      }
   },
   "required": [
      "type",
      "run_id",
      "status",
      "values"
   ]
}

Config:

• populate_by_name: bool = True

• validate_assignment: bool = True

• protected_namespaces: tuple = ()

Fields:

• messages (List[agntcy_acp.acp_v0.models.message.Message] | None)

• run_id (str)

• status (agntcy_acp.acp_v0.models.run_status.RunStatus)

• type (str)

• values (Dict[str, Any])

Validators:

• type_validate_enum » type

field messages: List[Message] | None = None

Stream of messages returned by the run.

field run_id: StrictStr [Required]

The ID of the run.

Constraints:

• strict = True

field status: RunStatus [Required]

Status of the Run when this result was generated. This is particurarly useful when this data structure is used for streaming results. As the server can indicate an interrupt or an error condition while streaming the result.

field type: StrictStr [Required]

Constraints:

• strict = True

Validated by:

• type_validate_enum

field values: Dict[str, Any] [Required]

The output of the agent. The schema is described in agent ACP descriptor under ‘spec.output’.

classmethod from_dict(obj: Dict[str, Any] | None) → Self | None

Create an instance of ValueRunResultUpdate from a dict

classmethod from_json(json_str: str) → Self | None

Create an instance of ValueRunResultUpdate from a JSON string

validator type_validate_enum  »  type

Validates the enum

to_dict() → Dict[str, Any]

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

• None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

to_json() → str

Returns the JSON representation of the model using alias

to_str() → str

Returns the string representation of the model using alias