api.md

Health

Types:

from codex.types import HealthCheckResponse

Methods:

• client.health.check() -> HealthCheckResponse
• client.health.db() -> HealthCheckResponse

Organizations

Types:

from codex.types import (
    OrganizationSchemaPublic,
    OrganizationListMembersResponse,
    OrganizationRetrievePermissionsResponse,
)

Methods:

• client.organizations.retrieve(organization_id) -> OrganizationSchemaPublic
• client.organizations.list_members(organization_id) -> OrganizationListMembersResponse
• client.organizations.retrieve_permissions(organization_id) -> OrganizationRetrievePermissionsResponse

Billing

Types:

from codex.types.organizations import (
    OrganizationBillingInvoicesSchema,
    OrganizationBillingUsageSchema,
)

Methods:

• client.organizations.billing.invoices(organization_id) -> OrganizationBillingInvoicesSchema
• client.organizations.billing.usage(organization_id) -> OrganizationBillingUsageSchema

CardDetails

Types:

from codex.types.organizations.billing import OrganizationBillingCardDetails

Methods:

• client.organizations.billing.card_details.retrieve(organization_id) -> Optional[OrganizationBillingCardDetails]

SetupIntent

Types:

from codex.types.organizations.billing import OrganizationBillingSetupIntent

Methods:

• client.organizations.billing.setup_intent.create(organization_id) -> OrganizationBillingSetupIntent

PlanDetails

Types:

from codex.types.organizations.billing import OrganizationBillingPlanDetails

Methods:

• client.organizations.billing.plan_details.retrieve(organization_id) -> OrganizationBillingPlanDetails

Users

Methods:

• client.users.activate_account(**params) -> UserSchemaPublic

Myself

Types:

from codex.types.users import UserSchema, UserSchemaPublic

Methods:

• client.users.myself.retrieve() -> UserSchemaPublic

APIKey

Methods:

• client.users.myself.api_key.retrieve() -> UserSchemaPublic
• client.users.myself.api_key.refresh() -> UserSchema

Organizations

Types:

from codex.types.users.myself import UserOrganizationsSchema

Methods:

• client.users.myself.organizations.list() -> UserOrganizationsSchema

Verification

Types:

from codex.types.users import VerificationResendResponse

Methods:

• client.users.verification.resend() -> VerificationResendResponse

Projects

Types:

from codex.types import (
    ProjectReturnSchema,
    ProjectRetrieveResponse,
    ProjectListResponse,
    ProjectExportResponse,
    ProjectIncrementQueriesResponse,
    ProjectRetrieveAnalyticsResponse,
)

Methods:

• client.projects.create(**params) -> ProjectReturnSchema
• client.projects.retrieve(project_id) -> ProjectRetrieveResponse
• client.projects.update(project_id, **params) -> ProjectReturnSchema
• client.projects.list(**params) -> ProjectListResponse
• client.projects.delete(project_id) -> None
• client.projects.export(project_id) -> object
• client.projects.increment_queries(project_id) -> object
• client.projects.retrieve_analytics(project_id, **params) -> ProjectRetrieveAnalyticsResponse

AccessKeys

Types:

from codex.types.projects import (
    AccessKeySchema,
    AccessKeyListResponse,
    AccessKeyRetrieveProjectIDResponse,
)

Methods:

• client.projects.access_keys.create(project_id, **params) -> AccessKeySchema
• client.projects.access_keys.retrieve(access_key_id, *, project_id) -> AccessKeySchema
• client.projects.access_keys.update(access_key_id, *, project_id, **params) -> AccessKeySchema
• client.projects.access_keys.list(project_id) -> AccessKeyListResponse
• client.projects.access_keys.delete(access_key_id, *, project_id) -> None
• client.projects.access_keys.retrieve_project_id() -> AccessKeyRetrieveProjectIDResponse
• client.projects.access_keys.revoke(access_key_id, *, project_id) -> None

Entries

Types:

from codex.types.projects import Entry, EntryNotifySmeResponse, EntryQueryResponse

Methods:

• client.projects.entries.create(project_id, **params) -> Entry
• client.projects.entries.retrieve(entry_id, *, project_id) -> Entry
• client.projects.entries.update(entry_id, *, project_id, **params) -> Entry
• client.projects.entries.delete(entry_id, *, project_id) -> None
• client.projects.entries.notify_sme(entry_id, *, project_id, **params) -> EntryNotifySmeResponse
• client.projects.entries.publish_draft_answer(entry_id, *, project_id) -> Entry
• client.projects.entries.query(project_id, **params) -> EntryQueryResponse
• client.projects.entries.unpublish_answer(entry_id, *, project_id) -> Entry

Clusters

Types:

from codex.types.projects import ClusterListResponse, ClusterListVariantsResponse

Methods:

• client.projects.clusters.list(project_id, **params) -> SyncOffsetPageClusters[ClusterListResponse]
• client.projects.clusters.list_variants(representative_entry_id, *, project_id) -> ClusterListVariantsResponse

Tlm

Types:

from codex.types import TlmPromptResponse, TlmScoreResponse

Methods:

• client.tlm.prompt(**params) -> TlmPromptResponse
• client.tlm.score(**params) -> TlmScoreResponse