api.md

Assistants

Types:

from agility.types import (
    Assistant,
    AssistantWithConfig,
    AssistantListResponse,
    AssistantRetrieveRunMetadataResponse,
)

Methods:

• client.assistants.create(**params) -> Assistant
• client.assistants.retrieve(assistant_id) -> AssistantWithConfig
• client.assistants.update(assistant_id, **params) -> AssistantWithConfig
• client.assistants.list(**params) -> SyncMyOffsetPage[AssistantListResponse]
• client.assistants.delete(assistant_id) -> None
• client.assistants.retrieve_run_metadata(run_id, *, assistant_id) -> AssistantRetrieveRunMetadataResponse

AccessKeys

Types:

from agility.types.assistants import AccessKey

Methods:

• client.assistants.access_keys.create(assistant_id, **params) -> AccessKey
• client.assistants.access_keys.list(assistant_id, **params) -> SyncMyOffsetPage[AccessKey]

KnowledgeBases

Types:

from agility.types import KnowledgeBaseWithConfig, KnowledgeBaseListResponse

Methods:

• client.knowledge_bases.create(**params) -> KnowledgeBaseWithConfig
• client.knowledge_bases.retrieve(knowledge_base_id) -> KnowledgeBaseWithConfig
• client.knowledge_bases.update(knowledge_base_id, **params) -> KnowledgeBaseWithConfig
• client.knowledge_bases.list(**params) -> SyncMyOffsetPage[KnowledgeBaseListResponse]
• client.knowledge_bases.delete(knowledge_base_id) -> None

Sources

Types:

from agility.types.knowledge_bases import Source, SourceStatusResponse

Methods:

• client.knowledge_bases.sources.create(knowledge_base_id, **params) -> Source
• client.knowledge_bases.sources.retrieve(source_id, *, knowledge_base_id) -> Source
• client.knowledge_bases.sources.update(source_id, *, knowledge_base_id, **params) -> Source
• client.knowledge_bases.sources.list(knowledge_base_id, **params) -> SyncMyOffsetPage[Source]
• client.knowledge_bases.sources.delete(source_id, *, knowledge_base_id) -> None
• client.knowledge_bases.sources.status(source_id, *, knowledge_base_id) -> SourceStatusResponse
• client.knowledge_bases.sources.sync(source_id, *, knowledge_base_id) -> object

Documents

Types:

from agility.types.knowledge_bases.sources import Document

Methods:

• client.knowledge_bases.sources.documents.retrieve(document_id, *, knowledge_base_id, source_id) -> Document
• client.knowledge_bases.sources.documents.list(source_id, *, knowledge_base_id, **params) -> SyncMyOffsetPage[Document]

Users

Types:

from agility.types import User

Methods:

• client.users.retrieve(user_id) -> User

APIKey

Types:

from agility.types.users import APIKeyRetrieveResponse

Methods:

• client.users.api_key.retrieve(user_id) -> str
• client.users.api_key.refresh(user_id) -> User

Threads

Types:

from agility.types import Thread

Methods:

• client.threads.create() -> Thread
• client.threads.retrieve(thread_id) -> Thread
• client.threads.list(**params) -> SyncMyOffsetPage[Thread]
• client.threads.delete(thread_id) -> None

Messages

Types:

from agility.types.threads import Message

Methods:

• client.threads.messages.create(thread_id, **params) -> Message
• client.threads.messages.retrieve(message_id, *, thread_id) -> Message
• client.threads.messages.list(thread_id, **params) -> SyncMyOffsetPage[Message]
• client.threads.messages.delete(message_id, *, thread_id) -> None

Runs

Types:

from agility.types.threads import Run

Methods:

• client.threads.runs.create(thread_id, **params) -> Run
• client.threads.runs.retrieve(run_id, *, thread_id) -> Run
• client.threads.runs.delete(run_id, *, thread_id) -> None
• client.threads.runs.stream(thread_id, **params) -> object

Integrations

Types:

from agility.types import (
    GcSv0Integration,
    Integration,
    S3V0Integration,
    IntegrationCreateResponse,
    IntegrationRetrieveResponse,
    IntegrationListResponse,
)

Methods:

• client.integrations.create(**params) -> IntegrationCreateResponse
• client.integrations.retrieve(integration_id) -> IntegrationRetrieveResponse
• client.integrations.list(**params) -> SyncMyOffsetPage[IntegrationListResponse]
• client.integrations.delete(integration_id) -> None

Available

Types:

from agility.types.integrations import IntegrationTypeDef, AvailableListResponse

Methods:

• client.integrations.available.list() -> AvailableListResponse

Rbac

Methods:

• client.integrations.rbac.verify(integration_id) -> Integration