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,
    ProjectDetectResponse,
    ProjectInviteSmeResponse,
    ProjectRetrieveAnalyticsResponse,
    ProjectValidateResponse,
)

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.create_from_template(**params) -> ProjectReturnSchema
• client.projects.detect(project_id, **params) -> ProjectDetectResponse
• client.projects.export(project_id) -> object
• client.projects.invite_sme(project_id, **params) -> ProjectInviteSmeResponse
• client.projects.retrieve_analytics(project_id, **params) -> ProjectRetrieveAnalyticsResponse
• client.projects.validate(project_id, **params) -> ProjectValidateResponse

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

Evals

Types:

from codex.types.projects import EvalListResponse

Methods:

• client.projects.evals.create(project_id, **params) -> ProjectReturnSchema
• client.projects.evals.update(path_eval_key, *, project_id, **params) -> ProjectReturnSchema
• client.projects.evals.list(project_id, **params) -> EvalListResponse
• client.projects.evals.delete(eval_key, *, project_id) -> ProjectReturnSchema

QueryLogs

Types:

from codex.types.projects import (
    QueryLogRetrieveResponse,
    QueryLogListResponse,
    QueryLogAddUserFeedbackResponse,
    QueryLogListByGroupResponse,
    QueryLogListGroupsResponse,
    QueryLogStartRemediationResponse,
    QueryLogUpdateMetadataResponse,
)

Methods:

• client.projects.query_logs.retrieve(query_log_id, *, project_id) -> QueryLogRetrieveResponse
• client.projects.query_logs.list(project_id, **params) -> SyncOffsetPageQueryLogs[QueryLogListResponse]
• client.projects.query_logs.add_user_feedback(query_log_id, *, project_id, **params) -> QueryLogAddUserFeedbackResponse
• client.projects.query_logs.list_by_group(project_id, **params) -> QueryLogListByGroupResponse
• client.projects.query_logs.list_groups(project_id, **params) -> SyncOffsetPageQueryLogGroups[QueryLogListGroupsResponse]
• client.projects.query_logs.start_remediation(query_log_id, *, project_id) -> QueryLogStartRemediationResponse
• client.projects.query_logs.update_metadata(query_log_id, *, project_id, **params) -> QueryLogUpdateMetadataResponse

Remediations

Types:

from codex.types.projects import (
    RemediationCreateResponse,
    RemediationRetrieveResponse,
    RemediationListResponse,
    RemediationEditAnswerResponse,
    RemediationEditDraftAnswerResponse,
    RemediationGetResolvedLogsCountResponse,
    RemediationListResolvedLogsResponse,
    RemediationPauseResponse,
    RemediationPublishResponse,
    RemediationUnpauseResponse,
)

Methods:

• client.projects.remediations.create(project_id, **params) -> RemediationCreateResponse
• client.projects.remediations.retrieve(remediation_id, *, project_id) -> RemediationRetrieveResponse
• client.projects.remediations.list(project_id, **params) -> SyncOffsetPageRemediations[RemediationListResponse]
• client.projects.remediations.delete(remediation_id, *, project_id) -> None
• client.projects.remediations.edit_answer(remediation_id, *, project_id, **params) -> RemediationEditAnswerResponse
• client.projects.remediations.edit_draft_answer(remediation_id, *, project_id, **params) -> RemediationEditDraftAnswerResponse
• client.projects.remediations.get_resolved_logs_count(remediation_id, *, project_id) -> RemediationGetResolvedLogsCountResponse
• client.projects.remediations.list_resolved_logs(remediation_id, *, project_id) -> RemediationListResolvedLogsResponse
• client.projects.remediations.pause(remediation_id, *, project_id) -> RemediationPauseResponse
• client.projects.remediations.publish(remediation_id, *, project_id) -> RemediationPublishResponse
• client.projects.remediations.unpause(remediation_id, *, project_id) -> RemediationUnpauseResponse

ExpertAnswers

Types:

from codex.types.projects.remediations import (
    ExpertAnswerCreateResponse,
    ExpertAnswerRetrieveResponse,
    ExpertAnswerListResponse,
    ExpertAnswerEditAnswerResponse,
    ExpertAnswerEditDraftAnswerResponse,
    ExpertAnswerPauseResponse,
    ExpertAnswerPublishResponse,
    ExpertAnswerUnpauseResponse,
)

Methods:

• client.projects.remediations.expert_answers.create(project_id, **params) -> ExpertAnswerCreateResponse
• client.projects.remediations.expert_answers.retrieve(expert_answer_id, *, project_id) -> ExpertAnswerRetrieveResponse
• client.projects.remediations.expert_answers.list(project_id, **params) -> SyncOffsetPageExpertAnswers[ExpertAnswerListResponse]
• client.projects.remediations.expert_answers.delete(expert_answer_id, *, project_id) -> None
• client.projects.remediations.expert_answers.edit_answer(expert_answer_id, *, project_id, **params) -> ExpertAnswerEditAnswerResponse
• client.projects.remediations.expert_answers.edit_draft_answer(expert_answer_id, *, project_id, **params) -> ExpertAnswerEditDraftAnswerResponse
• client.projects.remediations.expert_answers.pause(expert_answer_id, *, project_id) -> ExpertAnswerPauseResponse
• client.projects.remediations.expert_answers.publish(expert_answer_id, *, project_id) -> ExpertAnswerPublishResponse
• client.projects.remediations.expert_answers.unpause(expert_answer_id, *, project_id) -> ExpertAnswerUnpauseResponse

ExpertReviews

Types:

from codex.types.projects.remediations import (
    ExpertReviewCreateResponse,
    ExpertReviewRetrieveResponse,
    ExpertReviewListResponse,
    ExpertReviewEditResponse,
)

Methods:

• client.projects.remediations.expert_reviews.create(project_id, **params) -> ExpertReviewCreateResponse
• client.projects.remediations.expert_reviews.retrieve(expert_review_id, *, project_id) -> ExpertReviewRetrieveResponse
• client.projects.remediations.expert_reviews.list(project_id, **params) -> SyncOffsetPageExpertReviews[ExpertReviewListResponse]
• client.projects.remediations.expert_reviews.delete(expert_review_id, *, project_id, **params) -> None
• client.projects.remediations.expert_reviews.edit(expert_review_id, *, project_id, **params) -> ExpertReviewEditResponse