agntcy_acp.models package

Module contents

class agntcy_acp.models.Agent(**data)

Bases: BaseModel

A description of an agent supported by this server

agent_id: StrictStr

classmethod from_dict(obj)

Create an instance of Agent from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Agent from a JSON string

Return type:

Optional[Self]

metadata: AgentMetadata

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.AgentACPDescriptor(**data)

Bases: BaseModel

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

classmethod from_dict(obj)

Create an instance of AgentACPDescriptor from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AgentACPDescriptor from a JSON string

Return type:

Optional[Self]

metadata: AgentMetadata

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

specs: AgentACPSpec

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.AgentACPSpec(**data)

Bases: BaseModel

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

capabilities: AgentCapabilities

config: Dict[str, Any]

custom_streaming_update: Optional[Dict[str, Any]]

classmethod from_dict(obj)

Create an instance of AgentACPSpec from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AgentACPSpec from a JSON string

Return type:

Optional[Self]

input: Dict[str, Any]

interrupts: Optional[List[AgentACPSpecInterruptsInner]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output: Dict[str, Any]

thread_state: Optional[Dict[str, Any]]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.AgentACPSpecInterruptsInner(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of AgentACPSpecInterruptsInner from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AgentACPSpecInterruptsInner from a JSON string

Return type:

Optional[Self]

interrupt_payload: Dict[str, Any]

interrupt_type: StrictStr

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resume_payload: Dict[str, Any]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.AgentCapabilities(**data)

Bases: BaseModel

Declares what invocation features this agent is capable of.

callbacks: Optional[StrictBool]

classmethod from_dict(obj)

Create an instance of AgentCapabilities from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AgentCapabilities from a JSON string

Return type:

Optional[Self]

interrupts: Optional[StrictBool]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

streaming: Optional[StreamingModes]

threads: Optional[StrictBool]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.AgentConnectProtocol(**data)

Bases: BaseModel

agent_id: Optional[UUID]

authentication: Optional[SecurityScheme]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

type: Type8

url: AnyUrl

class agntcy_acp.models.AgentDependency(**data)

Bases: BaseModel

deployment_option: Optional[str]

env_var_values: Optional[EnvVarValues]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

ref: AgentRef

class agntcy_acp.models.AgentDeployment(**data)

Bases: BaseModel

dependencies: Optional[List[AgentDependency]]

deployment_options: List[DeploymentOptions]

env_vars: Optional[List[EnvVar]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.AgentManifest(**data)

Bases: BaseModel

deployment: Optional[AgentDeployment]

metadata: AgentMetadata

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

specs: AgentACPSpec

class agntcy_acp.models.AgentMetadata(**data)

Bases: BaseModel

Basic information associated to the agent

description: StrictStr

classmethod from_dict(obj)

Create an instance of AgentMetadata from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AgentMetadata from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

ref: AgentRef

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.AgentRef(**data)

Bases: BaseModel

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

classmethod from_dict(obj)

Create an instance of AgentRef from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AgentRef from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: StrictStr

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

url: Optional[StrictStr]

version: StrictStr

class agntcy_acp.models.AgentSearchRequest(**data)

Bases: BaseModel

Payload for listing agents.

classmethod from_dict(obj)

Create an instance of AgentSearchRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of AgentSearchRequest from a JSON string

Return type:

Optional[Self]

limit: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[StrictStr]

offset: Optional[Annotated[int, Field(strict=True, ge=0)]]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

version: Optional[StrictStr]

class agntcy_acp.models.Capabilities(**data)

Bases: BaseModel

callbacks: Optional[bool]

interrupts: Optional[bool]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

streaming: Optional[Streaming]

threads: Optional[bool]

class agntcy_acp.models.Config(**data)

Bases: BaseModel

The configuration for the agent.

configurable: Optional[Dict[str, Any]]

classmethod from_dict(obj)

Create an instance of Config from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Config from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

recursion_limit: Optional[StrictInt]

tags: Optional[List[StrictStr]]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.ConfigSchema(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.Content(*args, **kwargs)

Bases: BaseModel

The content of the message.

actual_instance: Optional[Union[List[ContentOneOfInner], str]]

classmethod actual_instance_must_validate_oneof(v)

classmethod from_dict(obj)

Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]

oneof_schema_1_validator: Optional[StrictStr]

oneof_schema_2_validator: Optional[List[ContentOneOfInner]]

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], List[ContentOneOfInner], str, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

class agntcy_acp.models.ContentOneOfInner(*args, **kwargs)

Bases: BaseModel

actual_instance: Any

classmethod actual_instance_must_validate_anyof(v)

any_of_schemas: Set[str]

anyof_schema_1_validator: Optional[MessageTextBlock]

anyof_schema_2_validator: Optional[MessageAnyBlock]

classmethod from_dict(obj)

Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], MessageAnyBlock, MessageTextBlock, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

class agntcy_acp.models.CustomRunResultUpdate(**data)

Bases: BaseModel

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

classmethod from_dict(obj)

Create an instance of CustomRunResultUpdate from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of CustomRunResultUpdate from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_id: Optional[StrictStr]

status: RunStatus

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

classmethod type_validate_enum(value)

Validates the enum

update: Dict[str, Any]

class agntcy_acp.models.DeploymentOptions(root=PydanticUndefined, **data)

Bases: RootModel[Union[SourceCodeDeployment, RemoteServiceDeployment, DockerDeployment]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: Union[SourceCodeDeployment, RemoteServiceDeployment, DockerDeployment]

class agntcy_acp.models.DockerDeployment(**data)

Bases: BaseModel

image: AnyUrl

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

type: Literal['docker']

class agntcy_acp.models.EnvVar(**data)

Bases: BaseModel

defaultValue: Optional[str]

desc: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

required: Optional[bool]

class agntcy_acp.models.EnvVarValues(**data)

Bases: BaseModel

dependencies: Optional[List[EnvVarValues]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

values: Optional[Dict[str, str]]

class agntcy_acp.models.ErrorResponse(root=PydanticUndefined, **data)

Bases: RootModel[str]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

root: str

class agntcy_acp.models.FrameworkType(*values)

Bases: Enum

langgraph = 'langgraph'

class agntcy_acp.models.InputSchema(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.Interrupt(**data)

Bases: BaseModel

interrupt_payload: Dict[str, Any]

interrupt_type: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

resume_payload: Dict[str, Any]

class agntcy_acp.models.InterruptPayloadSchema(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.LangGraphConfig(**data)

Bases: BaseModel

framework_type: Literal['langgraph']

graph: str

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.LlamaIndexConfig(**data)

Bases: BaseModel

framework_type: Literal['llamaindex']

interrupts: Optional[Dict[str, InterruptConfig]]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

path: str

class agntcy_acp.models.Message(**data)

Bases: BaseModel

content: Content

classmethod from_dict(obj)

Create an instance of Message from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Message from a JSON string

Return type:

Optional[Self]

id: Optional[StrictStr]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

role: StrictStr

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.MessageAnyBlock(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of MessageAnyBlock from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MessageAnyBlock from a JSON string

Return type:

Optional[Self]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

class agntcy_acp.models.MessageTextBlock(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of MessageTextBlock from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of MessageTextBlock from a JSON string

Return type:

Optional[Self]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

text: StrictStr

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: Optional[Any]

class agntcy_acp.models.OutputSchema(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.RemoteServiceDeployment(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

protocol: AgentConnectProtocol

type: Literal['remote_service']

class agntcy_acp.models.ResumePayloadSchema(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.Run(**data)

Bases: BaseModel

Holds common information of a run

agent_id: StrictStr

created_at: datetime

classmethod from_dict(obj)

Create an instance of Run from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Run from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_id: StrictStr

status: RunStatus

thread_id: Optional[StrictStr]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

class agntcy_acp.models.RunCreate(**data)

Bases: BaseModel

Payload for creating a run.

after_seconds: Optional[StrictInt]

agent_id: Optional[StrictStr]

config: Optional[Config]

classmethod from_dict(obj)

Create an instance of RunCreate from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunCreate from a JSON string

Return type:

Optional[Self]

input: Optional[Dict[str, Any]]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

multitask_strategy: Optional[StrictStr]

classmethod multitask_strategy_validate_enum(value)

Validates the enum

on_disconnect: Optional[StrictStr]

classmethod on_disconnect_validate_enum(value)

Validates the enum

stream_mode: Optional[StreamMode]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

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

class agntcy_acp.models.RunCreateStateful(**data)

Bases: BaseModel

Payload for creating a stateful run.

after_seconds: Optional[StrictInt]

agent_id: Optional[StrictStr]

config: Optional[Config]

classmethod from_dict(obj)

Create an instance of RunCreateStateful from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunCreateStateful from a JSON string

Return type:

Optional[Self]

if_not_exists: Optional[StrictStr]

classmethod if_not_exists_validate_enum(value)

Validates the enum

input: Optional[Dict[str, Any]]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

multitask_strategy: Optional[StrictStr]

classmethod multitask_strategy_validate_enum(value)

Validates the enum

on_disconnect: Optional[StrictStr]

classmethod on_disconnect_validate_enum(value)

Validates the enum

stream_mode: Optional[StreamMode]

stream_subgraphs: Optional[StrictBool]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

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

class agntcy_acp.models.RunCreateStateless(**data)

Bases: BaseModel

Payload for creating a stateless run.

after_seconds: Optional[StrictInt]

agent_id: Optional[StrictStr]

config: Optional[Config]

classmethod from_dict(obj)

Create an instance of RunCreateStateless from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunCreateStateless from a JSON string

Return type:

Optional[Self]

input: Optional[Dict[str, Any]]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

multitask_strategy: Optional[StrictStr]

classmethod multitask_strategy_validate_enum(value)

Validates the enum

on_completion: Optional[StrictStr]

classmethod on_completion_validate_enum(value)

Validates the enum

on_disconnect: Optional[StrictStr]

classmethod on_disconnect_validate_enum(value)

Validates the enum

stream_mode: Optional[StreamMode]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

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

class agntcy_acp.models.RunError(**data)

Bases: BaseModel

Run terminated with an error

description: StrictStr

errcode: StrictInt

classmethod from_dict(obj)

Create an instance of RunError from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunError from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_id: StrictStr

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

classmethod type_validate_enum(value)

Validates the enum

class agntcy_acp.models.RunInterrupt(**data)

Bases: BaseModel

Interrupt occurred during a Run

classmethod from_dict(obj)

Create an instance of RunInterrupt from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunInterrupt from a JSON string

Return type:

Optional[Self]

interrupt: Dict[str, Any]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

classmethod type_validate_enum(value)

Validates the enum

class agntcy_acp.models.RunOutput(*args, **kwargs)

Bases: BaseModel

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

actual_instance: Optional[Union[RunError, RunInterrupt, RunResult]]

classmethod actual_instance_must_validate_oneof(v)

discriminator_value_class_map: Dict[str, str]

classmethod from_dict(obj)

Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]

oneof_schema_1_validator: Optional[RunResult]

oneof_schema_2_validator: Optional[RunInterrupt]

oneof_schema_3_validator: Optional[RunError]

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], RunError, RunInterrupt, RunResult, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

class agntcy_acp.models.RunOutputStream(**data)

Bases: BaseModel

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

data: StreamEventPayload

event: StrictStr

classmethod event_validate_enum(value)

Validates the enum

classmethod from_dict(obj)

Create an instance of RunOutputStream from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunOutputStream from a JSON string

Return type:

Optional[Self]

id: StrictStr

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.RunResult(**data)

Bases: BaseModel

Final result of a Run.

classmethod from_dict(obj)

Create an instance of RunResult from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunResult from a JSON string

Return type:

Optional[Self]

messages: Optional[List[Message]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

classmethod type_validate_enum(value)

Validates the enum

values: Optional[Dict[str, Any]]

class agntcy_acp.models.RunSearchRequest(**data)

Bases: BaseModel

Payload for listing runs.

agent_id: Optional[StrictStr]

classmethod from_dict(obj)

Create an instance of RunSearchRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunSearchRequest from a JSON string

Return type:

Optional[Self]

limit: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: Optional[Annotated[int, Field(strict=True, ge=0)]]

status: Optional[RunStatus]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.RunStateful(**data)

Bases: BaseModel

Holds all the information of a stateful run

agent_id: StrictStr

created_at: datetime

creation: RunCreateStateful

classmethod from_dict(obj)

Create an instance of RunStateful from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunStateful from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_id: StrictStr

status: RunStatus

thread_id: Optional[StrictStr]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

class agntcy_acp.models.RunStateless(**data)

Bases: BaseModel

Holds all the information of a stateless run

agent_id: StrictStr

created_at: datetime

creation: RunCreateStateless

classmethod from_dict(obj)

Create an instance of RunStateless from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunStateless from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_id: StrictStr

status: RunStatus

thread_id: Optional[StrictStr]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

class agntcy_acp.models.RunStatus(*values)

Bases: str, Enum

ERROR = 'error'

INTERRUPTED = 'interrupted'

PENDING = 'pending'

SUCCESS = 'success'

TIMEOUT = 'timeout'

classmethod from_json(json_str)

Create an instance of RunStatus from a JSON string

Return type:

Self

class agntcy_acp.models.RunWaitResponseStateful(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of RunWaitResponseStateful from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunWaitResponseStateful from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output: Optional[RunOutput]

run: Optional[RunStateful]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.RunWaitResponseStateless(**data)

Bases: BaseModel

classmethod from_dict(obj)

Create an instance of RunWaitResponseStateless from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of RunWaitResponseStateless from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output: Optional[RunOutput]

run: Optional[RunStateless]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.SecurityScheme(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.SourceCodeDeployment(**data)

Bases: BaseModel

framework_config: Union[LangGraphConfig, LlamaIndexConfig]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Optional[str]

type: Literal['source_code']

url: AnyUrl

class agntcy_acp.models.StreamEventPayload(*args, **kwargs)

Bases: BaseModel

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

actual_instance: Optional[Union[CustomRunResultUpdate, ValueRunErrorUpdate, ValueRunInterruptUpdate, ValueRunResultUpdate]]

classmethod actual_instance_must_validate_oneof(v)

discriminator_value_class_map: Dict[str, str]

classmethod from_dict(obj)

Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

one_of_schemas: Set[str]

oneof_schema_1_validator: Optional[ValueRunResultUpdate]

oneof_schema_2_validator: Optional[CustomRunResultUpdate]

oneof_schema_3_validator: Optional[ValueRunInterruptUpdate]

oneof_schema_4_validator: Optional[ValueRunErrorUpdate]

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], CustomRunResultUpdate, ValueRunErrorUpdate, ValueRunInterruptUpdate, ValueRunResultUpdate, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

class agntcy_acp.models.StreamMode(*args, **kwargs)

Bases: BaseModel

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

actual_instance: Any

classmethod actual_instance_must_validate_anyof(v)

any_of_schemas: Set[str]

anyof_schema_1_validator: Optional[List[StreamingMode]]

anyof_schema_2_validator: Optional[StreamingMode]

classmethod from_dict(obj)

Return type:

Self

classmethod from_json(json_str)

Returns the object represented by the json string

Return type:

Self

model_config: ClassVar[ConfigDict] = {'protected_namespaces': (), 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

Returns the dict representation of the actual instance

Return type:

Union[Dict[str, Any], List[StreamingMode], StreamingMode, None]

to_json()

Returns the JSON representation of the actual instance

Return type:

str

to_str()

Returns the string representation of the actual instance

Return type:

str

class agntcy_acp.models.StreamUpdateSchema(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.Streaming(**data)

Bases: BaseModel

custom: Optional[bool]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

values: Optional[bool]

class agntcy_acp.models.StreamingMode(*values)

Bases: str, Enum

CUSTOM = 'custom'

VALUES = 'values'

classmethod from_json(json_str)

Create an instance of StreamingMode from a JSON string

Return type:

Self

class agntcy_acp.models.StreamingModes(**data)

Bases: BaseModel

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

custom: Optional[StrictBool]

classmethod from_dict(obj)

Create an instance of StreamingModes from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of StreamingModes from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

values: Optional[StrictBool]

class agntcy_acp.models.Thread(**data)

Bases: BaseModel

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.

created_at: datetime

classmethod from_dict(obj)

Create an instance of Thread from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of Thread from a JSON string

Return type:

Optional[Self]

messages: Optional[List[Message]]

metadata: Dict[str, Any]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status: StrictStr

classmethod status_validate_enum(value)

Validates the enum

thread_id: StrictStr

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

updated_at: datetime

values: Optional[Dict[str, Any]]

class agntcy_acp.models.ThreadCheckpoint(**data)

Bases: BaseModel

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

checkpoint_id: StrictStr

classmethod from_dict(obj)

Create an instance of ThreadCheckpoint from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ThreadCheckpoint from a JSON string

Return type:

Optional[Self]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.ThreadCreate(**data)

Bases: BaseModel

Detail of an empty thread to be created.

classmethod from_dict(obj)

Create an instance of ThreadCreate from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ThreadCreate from a JSON string

Return type:

Optional[Self]

if_exists: Optional[StrictStr]

classmethod if_exists_validate_enum(value)

Validates the enum

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

thread_id: Optional[StrictStr]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

class agntcy_acp.models.ThreadPatch(**data)

Bases: BaseModel

Payload for updating a thread.

checkpoint: Optional[ThreadCheckpoint]

classmethod from_dict(obj)

Create an instance of ThreadPatch from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ThreadPatch from a JSON string

Return type:

Optional[Self]

messages: Optional[List[Message]]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

values: Optional[Dict[str, Any]]

class agntcy_acp.models.ThreadSearchRequest(**data)

Bases: BaseModel

Payload for listing threads.

classmethod from_dict(obj)

Create an instance of ThreadSearchRequest from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ThreadSearchRequest from a JSON string

Return type:

Optional[Self]

limit: Optional[Annotated[int, Field(le=1000, strict=True, ge=1)]]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

offset: Optional[Annotated[int, Field(strict=True, ge=0)]]

status: Optional[ThreadStatus]

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

values: Optional[Dict[str, Any]]

class agntcy_acp.models.ThreadState(**data)

Bases: BaseModel

checkpoint: ThreadCheckpoint

classmethod from_dict(obj)

Create an instance of ThreadState from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ThreadState from a JSON string

Return type:

Optional[Self]

messages: Optional[List[Message]]

metadata: Optional[Dict[str, Any]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

values: Dict[str, Any]

class agntcy_acp.models.ThreadStateSchema(**data)

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class agntcy_acp.models.ThreadStatus(*values)

Bases: str, Enum

BUSY = 'busy'

ERROR = 'error'

IDLE = 'idle'

INTERRUPTED = 'interrupted'

classmethod from_json(json_str)

Create an instance of ThreadStatus from a JSON string

Return type:

Self

class agntcy_acp.models.ValueRunResultUpdate(**data)

Bases: BaseModel

Partial result provided as value through streaming.

classmethod from_dict(obj)

Create an instance of ValueRunResultUpdate from a dict

Return type:

Optional[Self]

classmethod from_json(json_str)

Create an instance of ValueRunResultUpdate from a JSON string

Return type:

Optional[Self]

messages: Optional[List[Message]]

model_config: ClassVar[ConfigDict] = {'populate_by_name': True, 'protected_namespaces': (), 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

run_id: StrictStr

status: RunStatus

to_dict()

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.

Return type:

Dict[str, Any]

to_json()

Returns the JSON representation of the model using alias

Return type:

str

to_str()

Returns the string representation of the model using alias

Return type:

str

type: StrictStr

classmethod type_validate_enum(value)

Validates the enum

values: Dict[str, Any]