api.md

Agent

V1

Agents

Types:

from casedev.types.agent.v1 import (
    AgentCreateResponse,
    AgentRetrieveResponse,
    AgentUpdateResponse,
    AgentListResponse,
    AgentDeleteResponse,
)

Methods:

• client.agent.v1.agents.create(**params) -> AgentCreateResponse
• client.agent.v1.agents.retrieve(id) -> AgentRetrieveResponse
• client.agent.v1.agents.update(id, **params) -> AgentUpdateResponse
• client.agent.v1.agents.list(**params) -> AgentListResponse
• client.agent.v1.agents.delete(id) -> AgentDeleteResponse

Run

Types:

from casedev.types.agent.v1 import (
    RunCreateResponse,
    RunListResponse,
    RunCancelResponse,
    RunEventsResponse,
    RunExecResponse,
    RunGetDetailsResponse,
    RunGetStatusResponse,
    RunWatchResponse,
)

Methods:

• client.agent.v1.run.create(**params) -> RunCreateResponse
• client.agent.v1.run.list(**params) -> RunListResponse
• client.agent.v1.run.cancel(id) -> RunCancelResponse
• client.agent.v1.run.events(id, **params) -> str
• client.agent.v1.run.exec(id) -> RunExecResponse
• client.agent.v1.run.get_details(id) -> RunGetDetailsResponse
• client.agent.v1.run.get_status(id) -> RunGetStatusResponse
• client.agent.v1.run.watch(id, **params) -> RunWatchResponse

Execute

Types:

from casedev.types.agent.v1 import ExecuteCreateResponse

Methods:

• client.agent.v1.execute.create(**params) -> ExecuteCreateResponse

System

Types:

from casedev.types import SystemListServicesResponse

Methods:

• client.system.list_services() -> SystemListServicesResponse

Compute

V1

Types:

from casedev.types.compute import V1GetUsageResponse

Methods:

• client.compute.v1.get_pricing() -> None
• client.compute.v1.get_usage(**params) -> V1GetUsageResponse

Environments

Types:

from casedev.types.compute.v1 import (
    EnvironmentCreateResponse,
    EnvironmentRetrieveResponse,
    EnvironmentListResponse,
    EnvironmentDeleteResponse,
    EnvironmentSetDefaultResponse,
)

Methods:

• client.compute.v1.environments.create(**params) -> EnvironmentCreateResponse
• client.compute.v1.environments.retrieve(name) -> EnvironmentRetrieveResponse
• client.compute.v1.environments.list() -> EnvironmentListResponse
• client.compute.v1.environments.delete(name) -> EnvironmentDeleteResponse
• client.compute.v1.environments.set_default(name) -> EnvironmentSetDefaultResponse

InstanceTypes

Types:

from casedev.types.compute.v1 import InstanceTypeListResponse

Methods:

• client.compute.v1.instance_types.list() -> InstanceTypeListResponse

Instances

Types:

from casedev.types.compute.v1 import (
    InstanceCreateResponse,
    InstanceRetrieveResponse,
    InstanceListResponse,
    InstanceDeleteResponse,
)

Methods:

• client.compute.v1.instances.create(**params) -> InstanceCreateResponse
• client.compute.v1.instances.retrieve(id) -> InstanceRetrieveResponse
• client.compute.v1.instances.list() -> InstanceListResponse
• client.compute.v1.instances.delete(id) -> InstanceDeleteResponse

Secrets

Types:

from casedev.types.compute.v1 import (
    SecretCreateResponse,
    SecretListResponse,
    SecretDeleteGroupResponse,
    SecretRetrieveGroupResponse,
    SecretUpdateGroupResponse,
)

Methods:

• client.compute.v1.secrets.create(**params) -> SecretCreateResponse
• client.compute.v1.secrets.list(**params) -> SecretListResponse
• client.compute.v1.secrets.delete_group(group, **params) -> SecretDeleteGroupResponse
• client.compute.v1.secrets.retrieve_group(group, **params) -> SecretRetrieveGroupResponse
• client.compute.v1.secrets.update_group(group, **params) -> SecretUpdateGroupResponse

Database

V1

Types:

from casedev.types.database import V1GetUsageResponse

Methods:

• client.database.v1.get_usage() -> V1GetUsageResponse

Projects

Types:

from casedev.types.database.v1 import (
    ProjectCreateResponse,
    ProjectRetrieveResponse,
    ProjectListResponse,
    ProjectDeleteResponse,
    ProjectCreateBranchResponse,
    ProjectGetConnectionResponse,
    ProjectListBranchesResponse,
)

Methods:

• client.database.v1.projects.create(**params) -> ProjectCreateResponse
• client.database.v1.projects.retrieve(id) -> ProjectRetrieveResponse
• client.database.v1.projects.list() -> ProjectListResponse
• client.database.v1.projects.delete(id) -> ProjectDeleteResponse
• client.database.v1.projects.create_branch(id, **params) -> ProjectCreateBranchResponse
• client.database.v1.projects.get_connection(id, **params) -> ProjectGetConnectionResponse
• client.database.v1.projects.list_branches(id) -> ProjectListBranchesResponse

Format

V1

Methods:

• client.format.v1.create_document(**params) -> BinaryAPIResponse

Templates

Types:

from casedev.types.format.v1 import (
    TemplateCreateResponse,
    TemplateRetrieveResponse,
    TemplateListResponse,
)

Methods:

• client.format.v1.templates.create(**params) -> TemplateCreateResponse
• client.format.v1.templates.retrieve(id) -> TemplateRetrieveResponse
• client.format.v1.templates.list(**params) -> TemplateListResponse

Legal

V1

Types:

from casedev.types.legal import (
    DocketDetail,
    DocketSearchResult,
    V1DocketResponse,
    V1DraftResponse,
    V1FindResponse,
    V1GetCitationsResponse,
    V1GetCitationsFromURLResponse,
    V1GetFullTextResponse,
    V1ListCourtsResponse,
    V1ListJurisdictionsResponse,
    V1PatentSearchResponse,
    V1ResearchResponse,
    V1SecFilingResponse,
    V1SimilarResponse,
    V1TrademarkSearchResponse,
    V1VerifyResponse,
)

Methods:

• client.legal.v1.docket(**params) -> V1DocketResponse
• client.legal.v1.draft(**params) -> V1DraftResponse
• client.legal.v1.find(**params) -> V1FindResponse
• client.legal.v1.get_citations(**params) -> V1GetCitationsResponse
• client.legal.v1.get_citations_from_url(**params) -> V1GetCitationsFromURLResponse
• client.legal.v1.get_full_text(**params) -> V1GetFullTextResponse
• client.legal.v1.list_courts(**params) -> V1ListCourtsResponse
• client.legal.v1.list_jurisdictions(**params) -> V1ListJurisdictionsResponse
• client.legal.v1.patent_search(**params) -> V1PatentSearchResponse
• client.legal.v1.research(**params) -> V1ResearchResponse
• client.legal.v1.sec_filing(**params) -> V1SecFilingResponse
• client.legal.v1.similar(**params) -> V1SimilarResponse
• client.legal.v1.trademark_search(**params) -> V1TrademarkSearchResponse
• client.legal.v1.verify(**params) -> V1VerifyResponse

Matters

V1

Methods:

• client.matters.v1.create(**params) -> None
• client.matters.v1.retrieve(id) -> None
• client.matters.v1.update(id, **params) -> None
• client.matters.v1.list(**params) -> None

AgentTypes

Methods:

• client.matters.v1.agent_types.create(**params) -> None
• client.matters.v1.agent_types.list(**params) -> None

Parties

Methods:

• client.matters.v1.parties.create(**params) -> None
• client.matters.v1.parties.retrieve(party_id) -> None
• client.matters.v1.parties.update(party_id) -> None
• client.matters.v1.parties.list(**params) -> None

Types

Methods:

• client.matters.v1.types.create(**params) -> None
• client.matters.v1.types.retrieve(id) -> None
• client.matters.v1.types.update(id, **params) -> None
• client.matters.v1.types.list(**params) -> None

Events

Subscriptions

Methods:

• client.matters.v1.events.subscriptions.create(id, **params) -> None
• client.matters.v1.events.subscriptions.list(id) -> None
• client.matters.v1.events.subscriptions.delete(subscription_id, *, id) -> None

Log

Types:

from casedev.types.matters.v1 import LogExportResponse

Methods:

• client.matters.v1.log.create(id, **params) -> None
• client.matters.v1.log.list(id, **params) -> None
• client.matters.v1.log.export(id, **params) -> LogExportResponse

MatterParties

Methods:

• client.matters.v1.matter_parties.create(id, **params) -> None
• client.matters.v1.matter_parties.list(id) -> None

Shares

Methods:

• client.matters.v1.shares.create(id, **params) -> None
• client.matters.v1.shares.list(id) -> None
• client.matters.v1.shares.delete(share_id, *, id) -> None

WorkItems

Methods:

• client.matters.v1.work_items.create(id, **params) -> None
• client.matters.v1.work_items.retrieve(work_item_id, *, id) -> None
• client.matters.v1.work_items.update(work_item_id, *, id, **params) -> None
• client.matters.v1.work_items.list(id, **params) -> None
• client.matters.v1.work_items.decide(work_item_id, *, id, **params) -> None
• client.matters.v1.work_items.list_executions(work_item_id, *, id) -> None

Llm

Types:

from casedev.types import LlmGetConfigResponse

Methods:

• client.llm.get_config() -> LlmGetConfigResponse

V1

Types:

from casedev.types.llm import V1CreateEmbeddingResponse, V1ListModelsResponse

Methods:

• client.llm.v1.create_embedding(**params) -> V1CreateEmbeddingResponse
• client.llm.v1.list_models() -> V1ListModelsResponse

Chat

Types:

from casedev.types.llm.v1 import ChatCreateCompletionResponse

Methods:

• client.llm.v1.chat.create_completion(**params) -> ChatCreateCompletionResponse

Memory

V1

Types:

from casedev.types.memory import (
    V1CreateResponse,
    V1RetrieveResponse,
    V1ListResponse,
    V1DeleteResponse,
    V1DeleteAllResponse,
    V1SearchResponse,
)

Methods:

• client.memory.v1.create(**params) -> V1CreateResponse
• client.memory.v1.retrieve(id) -> V1RetrieveResponse
• client.memory.v1.list(**params) -> V1ListResponse
• client.memory.v1.delete(id) -> V1DeleteResponse
• client.memory.v1.delete_all(**params) -> V1DeleteAllResponse
• client.memory.v1.search(**params) -> V1SearchResponse

Media

V1

Clips

Methods:

• client.media.v1.clips.create() -> None
• client.media.v1.clips.retrieve(id) -> None

Transcripts

Search

Methods:

• client.media.v1.transcripts.search.create() -> None

Ocr

V1

Types:

from casedev.types.ocr import V1RetrieveResponse, V1ProcessResponse

Methods:

• client.ocr.v1.retrieve(id, **params) -> V1RetrieveResponse
• client.ocr.v1.download(type, *, id) -> BinaryAPIResponse
• client.ocr.v1.process(**params) -> V1ProcessResponse

Privilege

V1

Types:

from casedev.types.privilege import V1DetectResponse

Methods:

• client.privilege.v1.detect(**params) -> V1DetectResponse

Mail

V1

Inboxes

Methods:

• client.mail.v1.inboxes.create(**params) -> None
• client.mail.v1.inboxes.retrieve(inbox_id) -> None
• client.mail.v1.inboxes.list() -> None
• client.mail.v1.inboxes.delete(inbox_id) -> None
• client.mail.v1.inboxes.get_attachment(attachment_id, *, inbox_id, message_id) -> None
• client.mail.v1.inboxes.get_message(message_id, *, inbox_id) -> None
• client.mail.v1.inboxes.get_policy(inbox_id) -> None
• client.mail.v1.inboxes.list_messages(inbox_id) -> None
• client.mail.v1.inboxes.reply(message_id, *, inbox_id) -> None
• client.mail.v1.inboxes.send(inbox_id) -> None
• client.mail.v1.inboxes.set_policy(inbox_id, **params) -> None

Skills

Types:

from casedev.types import (
    ReadResponseFileBundle,
    ReadResponseRootBundle,
    SkillCreateResponse,
    SkillUpdateResponse,
    SkillDeleteResponse,
    SkillExportResponse,
    SkillReadResponse,
    SkillResolveResponse,
)

Methods:

• client.skills.create(**params) -> SkillCreateResponse
• client.skills.update(path_slug, **params) -> SkillUpdateResponse
• client.skills.delete(slug) -> SkillDeleteResponse
• client.skills.export(slug, **params) -> SkillExportResponse
• client.skills.read(slug) -> SkillReadResponse
• client.skills.resolve(**params) -> SkillResolveResponse

Custom

Types:

from casedev.types.skills import CustomListResponse

Methods:

• client.skills.custom.list(**params) -> CustomListResponse

Search

V1

Types:

from casedev.types.search import (
    V1AnswerResponse,
    V1ContentsResponse,
    V1ResearchResponse,
    V1RetrieveResearchResponse,
    V1SearchResponse,
    V1SimilarResponse,
)

Methods:

• client.search.v1.answer(**params) -> V1AnswerResponse
• client.search.v1.contents(**params) -> V1ContentsResponse
• client.search.v1.research(**params) -> V1ResearchResponse
• client.search.v1.retrieve_research(id, **params) -> V1RetrieveResearchResponse
• client.search.v1.search(**params) -> V1SearchResponse
• client.search.v1.similar(**params) -> V1SimilarResponse

Superdoc

V1

Methods:

• client.superdoc.v1.annotate(**params) -> BinaryAPIResponse
• client.superdoc.v1.convert(**params) -> BinaryAPIResponse

Translate

V1

Types:

from casedev.types.translate import V1DetectResponse, V1ListLanguagesResponse, V1TranslateResponse

Methods:

• client.translate.v1.detect(**params) -> V1DetectResponse
• client.translate.v1.list_languages(**params) -> V1ListLanguagesResponse
• client.translate.v1.translate(**params) -> V1TranslateResponse

Usage

V1

Methods:

• client.usage.v1.retrieve(**params) -> None

Subscriptions

Methods:

• client.usage.v1.subscriptions.create(**params) -> None
• client.usage.v1.subscriptions.update(subscription_id, **params) -> None
• client.usage.v1.subscriptions.list() -> None
• client.usage.v1.subscriptions.delete(subscription_id) -> None
• client.usage.v1.subscriptions.test(subscription_id, **params) -> None

Vault

Types:

from casedev.types import (
    VaultCreateResponse,
    VaultRetrieveResponse,
    VaultUpdateResponse,
    VaultListResponse,
    VaultDeleteResponse,
    VaultConfirmUploadResponse,
    VaultIngestResponse,
    VaultSearchResponse,
    VaultUploadResponse,
)

Methods:

• client.vault.create(**params) -> VaultCreateResponse
• client.vault.retrieve(id) -> VaultRetrieveResponse
• client.vault.update(id, **params) -> VaultUpdateResponse
• client.vault.list() -> VaultListResponse
• client.vault.delete(id, **params) -> VaultDeleteResponse
• client.vault.confirm_upload(object_id, *, id, **params) -> VaultConfirmUploadResponse
• client.vault.ingest(object_id, *, id) -> VaultIngestResponse
• client.vault.search(id, **params) -> VaultSearchResponse
• client.vault.upload(id, **params) -> VaultUploadResponse

Events

Subscriptions

Methods:

• client.vault.events.subscriptions.create(id, **params) -> None
• client.vault.events.subscriptions.update(subscription_id, *, id, **params) -> None
• client.vault.events.subscriptions.list(id) -> None
• client.vault.events.subscriptions.delete(subscription_id, *, id) -> None
• client.vault.events.subscriptions.test(subscription_id, *, id, **params) -> None

Graphrag

Types:

from casedev.types.vault import (
    GraphragGetStatsResponse,
    GraphragInitResponse,
    GraphragProcessObjectResponse,
)

Methods:

• client.vault.graphrag.get_stats(id) -> GraphragGetStatsResponse
• client.vault.graphrag.init(id) -> GraphragInitResponse
• client.vault.graphrag.process_object(object_id, *, id) -> GraphragProcessObjectResponse

Groups

Methods:

• client.vault.groups.create(**params) -> None
• client.vault.groups.update(group_id, **params) -> None
• client.vault.groups.list() -> None
• client.vault.groups.delete(group_id) -> None

Multipart

Types:

from casedev.types.vault import MultipartGetPartURLsResponse

Methods:

• client.vault.multipart.abort(id, **params) -> None
• client.vault.multipart.get_part_urls(id, **params) -> MultipartGetPartURLsResponse

Objects

Types:

from casedev.types.vault import (
    ObjectRetrieveResponse,
    ObjectUpdateResponse,
    ObjectListResponse,
    ObjectDeleteResponse,
    ObjectCreatePresignedURLResponse,
    ObjectGetChunksResponse,
    ObjectGetOcrWordsResponse,
    ObjectGetPagesResponse,
    ObjectGetSummarizeJobResponse,
    ObjectGetTextResponse,
)

Methods:

• client.vault.objects.retrieve(object_id, *, id) -> ObjectRetrieveResponse
• client.vault.objects.update(object_id, *, id, **params) -> ObjectUpdateResponse
• client.vault.objects.list(id) -> ObjectListResponse
• client.vault.objects.delete(object_id, *, id, **params) -> ObjectDeleteResponse
• client.vault.objects.create_presigned_url(object_id, *, id, **params) -> ObjectCreatePresignedURLResponse
• client.vault.objects.download(object_id, *, id) -> BinaryAPIResponse
• client.vault.objects.get_chunks(object_id, *, id, **params) -> ObjectGetChunksResponse
• client.vault.objects.get_ocr_words(object_id, *, id, **params) -> ObjectGetOcrWordsResponse
• client.vault.objects.get_pages(object_id, *, id, **params) -> ObjectGetPagesResponse
• client.vault.objects.get_summarize_job(job_id, *, id, object_id) -> ObjectGetSummarizeJobResponse
• client.vault.objects.get_text(object_id, *, id) -> ObjectGetTextResponse

Memory

Types:

from casedev.types.vault import MemoryCreateResponse, MemoryListResponse, MemorySearchResponse

Methods:

• client.vault.memory.create(id, **params) -> MemoryCreateResponse
• client.vault.memory.update(entry_id, *, id, **params) -> None
• client.vault.memory.list(id) -> MemoryListResponse
• client.vault.memory.delete(entry_id, *, id) -> None
• client.vault.memory.search(id, **params) -> MemorySearchResponse

Voice

Streaming

Types:

from casedev.types.voice import StreamingGetURLResponse

Methods:

• client.voice.streaming.get_url() -> StreamingGetURLResponse

BoostList

Types:

from casedev.types.voice import BoostListExtractResponse, BoostListGenerateResponse

Methods:

• client.voice.boost_list.extract(**params) -> BoostListExtractResponse
• client.voice.boost_list.generate(**params) -> BoostListGenerateResponse

Transcription

Types:

from casedev.types.voice import TranscriptionCreateResponse, TranscriptionRetrieveResponse

Methods:

• client.voice.transcription.create(**params) -> TranscriptionCreateResponse
• client.voice.transcription.retrieve(id, **params) -> TranscriptionRetrieveResponse
• client.voice.transcription.delete(id) -> None

V1

Types:

from casedev.types.voice import V1ListVoicesResponse

Methods:

• client.voice.v1.list_voices(**params) -> V1ListVoicesResponse

Speak

Methods:

• client.voice.v1.speak.create(**params) -> BinaryAPIResponse

Webhooks

V1

Endpoints

Methods:

• client.webhooks.v1.endpoints.create(**params) -> None
• client.webhooks.v1.endpoints.retrieve(id) -> None
• client.webhooks.v1.endpoints.update(id, **params) -> None
• client.webhooks.v1.endpoints.list(**params) -> None
• client.webhooks.v1.endpoints.delete(id) -> None
• client.webhooks.v1.endpoints.rotate_secret(id, **params) -> None
• client.webhooks.v1.endpoints.test(id, **params) -> None

Deliveries

Methods:

• client.webhooks.v1.deliveries.retrieve(id) -> None
• client.webhooks.v1.deliveries.list(**params) -> None
• client.webhooks.v1.deliveries.replay(id, **params) -> None

EventTypes

Methods:

• client.webhooks.v1.event_types.list() -> None