Loading...
    • Developer Guide
    • API Reference
    • MCP
    • Resources
    • Release Notes
    Search...
    ⌘K

    Using the API

    Features overviewClient SDKsBeta headersErrors
    Messages
    Create a Message
    Count tokens in a Message
    Batches
    Create a Message Batch
    Retrieve a Message Batch
    List Message Batches
    Cancel a Message Batch
    Delete a Message Batch
    Retrieve Message Batch results
    Models
    List Models
    Get a Model
    Beta
    Models
    List Models
    Get a Model
    Messages
    Create a Message
    Count tokens in a Message
    Batches
    Create a Message Batch
    Retrieve a Message Batch
    List Message Batches
    Cancel a Message Batch
    Delete a Message Batch
    Retrieve Message Batch results
    Files
    Upload File
    List Files
    Download File
    Get File Metadata
    Delete File
    Skills
    Create Skill
    List Skills
    Get Skill
    Delete Skill
    Versions
    Create Skill Version
    List Skill Versions
    Get Skill Version
    Delete Skill Version
    Admin
    Organizations
    Get Current Organization
    Invites
    Create Invite
    Get Invite
    List Invites
    Delete Invite
    Users
    Get User
    List Users
    Update User
    Remove User
    Workspaces
    Create Workspace
    Get Workspace
    List Workspaces
    Update Workspace
    Archive Workspace
    Members
    Create Workspace Member
    Get Workspace Member
    List Workspace Members
    Update Workspace Member
    Delete Workspace Member
    API Keys
    Get Api Key
    List Api Keys
    Update Api Key
    Usage Report
    Get Messages Usage Report
    Get Claude Code Usage Report
    Cost Report
    Get Cost Report
    Completions
    Create a Text Completion

    Support & configuration

    Rate limitsService tiersVersionsIP addressesSupported regionsOpenAI SDK compatibility
    Console

    Admin

    AdminAPI Keys

    List Api Keys
    client.admin.apiKeys.list(APIKeyListParams { after_id, before_id, created_by_user_id, 3 more } query?, RequestOptionsoptions?): Page<APIKey { id, created_at, created_by, 5 more } >
    get/v1/organizations/api_keys
    Get Api Key
    client.admin.apiKeys.retrieve(stringapiKeyID, RequestOptionsoptions?): APIKey { id, created_at, created_by, 5 more }
    get/v1/organizations/api_keys/{api_key_id}
    Update Api Key
    client.admin.apiKeys.update(stringapiKeyID, APIKeyUpdateParams { name, status } body, RequestOptionsoptions?): APIKey { id, created_at, created_by, 5 more }
    post/v1/organizations/api_keys/{api_key_id}

    AdminCost Report

    Get Cost Report
    client.admin.costReport.retrieve(CostReportRetrieveParams { starting_at, bucket_width, ending_at, 3 more } query, RequestOptionsoptions?): CostReport { data, has_more, next_page }
    get/v1/organizations/cost_report
    ModelsExpand Collapse
    CostReport { data, has_more, next_page }
    data: Array<Data>
    ending_at: string

    End of the time bucket (exclusive) in RFC 3339 format.

    results: Array<Result>

    List of cost items for this time bucket. There may be multiple items if one or more group_by[] parameters are specified.

    amount: string

    Cost amount in lowest currency units (e.g. cents) as a decimal string. For example, "123.45" in "USD" represents $1.23.

    context_window: "0-200k" | "200k-1M" | null

    Input context window used. Null if not grouping by description or for non-token costs.

    Accepts one of the following:
    "0-200k"
    "200k-1M"
    cost_type: "tokens" | "web_search" | "code_execution" | null

    Type of cost. Null if not grouping by description.

    Accepts one of the following:
    "tokens"
    "web_search"
    "code_execution"
    currency: string

    Currency code for the cost amount. Currently always "USD".

    description: string | null

    Description of the cost item. Null if not grouping by description.

    model: string | null

    Model name used. Null if not grouping by description or for non-token costs.

    service_tier: "standard" | "batch" | null

    Service tier used. Null if not grouping by description or for non-token costs.

    Accepts one of the following:
    "standard"
    "batch"
    token_type: "uncached_input_tokens" | "output_tokens" | "cache_read_input_tokens" | 2 more | null

    Type of token. Null if not grouping by description or for non-token costs.

    Accepts one of the following:
    "uncached_input_tokens"
    "output_tokens"
    "cache_read_input_tokens"
    "cache_creation.ephemeral_1h_input_tokens"
    "cache_creation.ephemeral_5m_input_tokens"
    workspace_id: string | null

    ID of the Workspace this cost is associated with. Null if not grouping by workspace or for the default workspace.

    starting_at: string

    Start of the time bucket (inclusive) in RFC 3339 format.

    has_more: boolean

    Indicates if there are more results.

    next_page: string | null

    Token to provide in as page in the subsequent request to retrieve the next page of data.

    formatdate-time

    AdminInvites

    Create Invite
    client.admin.invites.create(InviteCreateParams { email, role } body, RequestOptionsoptions?): Invite { id, email, expires_at, 4 more }
    post/v1/organizations/invites
    Delete Invite
    client.admin.invites.delete(stringinviteID, RequestOptionsoptions?): InviteDeleteResponse { id, type }
    delete/v1/organizations/invites/{invite_id}
    List Invites
    client.admin.invites.list(InviteListParams { after_id, before_id, limit } query?, RequestOptionsoptions?): Page<Invite { id, email, expires_at, 4 more } >
    get/v1/organizations/invites
    Get Invite
    client.admin.invites.retrieve(stringinviteID, RequestOptionsoptions?): Invite { id, email, expires_at, 4 more }
    get/v1/organizations/invites/{invite_id}
    ModelsExpand Collapse
    Invite { id, email, expires_at, 4 more }
    id: string

    ID of the Invite.

    email: string

    Email of the User being invited.

    expires_at: string

    RFC 3339 datetime string indicating when the Invite expires.

    formatdate-time
    invited_at: string

    RFC 3339 datetime string indicating when the Invite was created.

    formatdate-time
    role: "user" | "developer" | "billing" | 2 more

    Organization role of the User.

    Accepts one of the following:
    "user"
    "developer"
    "billing"
    "admin"
    "claude_code_user"
    status: "accepted" | "expired" | "deleted" | "pending"

    Status of the Invite.

    Accepts one of the following:
    "accepted"
    "expired"
    "deleted"
    "pending"
    type: "invite"

    Object type.

    For Invites, this is always "invite".

    Accepts one of the following:
    "invite"

    AdminOrganizations

    Get Current Organization
    client.admin.organizations.me(RequestOptionsoptions?): Organization { id, name, type }
    get/v1/organizations/me
    ModelsExpand Collapse
    Organization { id, name, type }
    id: string

    ID of the Organization.

    formatuuid
    name: string

    Name of the Organization.

    type: "organization"

    Object type.

    For Organizations, this is always "organization".

    Accepts one of the following:
    "organization"

    AdminUsage Report

    Get Claude Code Usage Report
    client.admin.usageReport.retrieveClaudeCode(UsageReportRetrieveClaudeCodeParams { starting_at, limit, page } query, RequestOptionsoptions?): ClaudeCodeUsageReport { data, has_more, next_page }
    get/v1/organizations/usage_report/claude_code
    Get Messages Usage Report
    client.admin.usageReport.retrieveMessages(UsageReportRetrieveMessagesParams { starting_at, api_key_ids, bucket_width, 8 more } query, RequestOptionsoptions?): MessagesUsageReport { data, has_more, next_page }
    get/v1/organizations/usage_report/messages
    ModelsExpand Collapse
    ClaudeCodeUsageReport { data, has_more, next_page }
    data: Array<Data>

    List of Claude Code usage records for the requested date.

    actor: UserActor { email_address, type } | APIActor { api_key_name, type }

    The user or API key that performed the Claude Code actions.

    Accepts one of the following:
    UserActor { email_address, type }
    email_address: string

    Email address of the user who performed Claude Code actions.

    type: "user_actor"
    Accepts one of the following:
    "user_actor"
    APIActor { api_key_name, type }
    api_key_name: string

    Name of the API key used to perform Claude Code actions.

    type: "api_actor"
    Accepts one of the following:
    "api_actor"
    core_metrics: CoreMetrics { commits_by_claude_code, lines_of_code, num_sessions, pull_requests_by_claude_code }

    Core productivity metrics measuring Claude Code usage and impact.

    commits_by_claude_code: number

    Number of git commits created through Claude Code's commit functionality.

    lines_of_code: LinesOfCode { added, removed }

    Statistics on code changes made through Claude Code.

    added: number

    Total number of lines of code added across all files by Claude Code.

    removed: number

    Total number of lines of code removed across all files by Claude Code.

    num_sessions: number

    Number of distinct Claude Code sessions initiated by this actor.

    pull_requests_by_claude_code: number

    Number of pull requests created through Claude Code's PR functionality.

    customer_type: "api" | "subscription"

    Type of customer account (api for API customers, subscription for Pro/Team customers).

    Accepts one of the following:
    "api"
    "subscription"
    date: string

    UTC date for the usage metrics in YYYY-MM-DD format.

    formatdate-time
    model_breakdown: Array<ModelBreakdown>

    Token usage and cost breakdown by AI model used.

    estimated_cost: EstimatedCost { amount, currency }

    Estimated cost for using this model

    amount: number

    Estimated cost amount in minor currency units (e.g., cents for USD).

    currency: string

    Currency code for the estimated cost (e.g., 'USD').

    model: string

    Name of the AI model used for Claude Code interactions.

    tokens: Tokens { cache_creation, cache_read, input, output }

    Token usage breakdown for this model

    cache_creation: number

    Number of cache creation tokens consumed by this model.

    cache_read: number

    Number of cache read tokens consumed by this model.

    input: number

    Number of input tokens consumed by this model.

    output: number

    Number of output tokens generated by this model.

    organization_id: string

    ID of the organization that owns the Claude Code usage.

    terminal_type: string

    Type of terminal or environment where Claude Code was used.

    tool_actions: Record<string, ToolActions>

    Breakdown of tool action acceptance and rejection rates by tool type.

    accepted: number

    Number of tool action proposals that the user accepted.

    rejected: number

    Number of tool action proposals that the user rejected.

    subscription_type?: "enterprise" | "team" | null

    Subscription tier for subscription customers. Null for API customers.

    Accepts one of the following:
    "enterprise"
    "team"
    has_more: boolean

    True if there are more records available beyond the current page.

    next_page: string | null

    Opaque cursor token for fetching the next page of results, or null if no more pages are available.

    MessagesUsageReport { data, has_more, next_page }
    data: Array<Data>
    ending_at: string

    End of the time bucket (exclusive) in RFC 3339 format.

    formatdate-time
    results: Array<Result>

    List of usage items for this time bucket. There may be multiple items if one or more group_by[] parameters are specified.

    api_key_id: string | null

    ID of the API key used. Null if not grouping by API key or for usage in the Anthropic Console.

    cache_creation: CacheCreation { ephemeral_1h_input_tokens, ephemeral_5m_input_tokens }

    The number of input tokens for cache creation.

    ephemeral_1h_input_tokens: number

    The number of input tokens used to create the 1 hour cache entry.

    ephemeral_5m_input_tokens: number

    The number of input tokens used to create the 5 minute cache entry.

    cache_read_input_tokens: number

    The number of input tokens read from the cache.

    context_window: "0-200k" | "200k-1M" | null

    Context window used. Null if not grouping by context window.

    Accepts one of the following:
    "0-200k"
    "200k-1M"
    model: string | null

    Model used. Null if not grouping by model.

    output_tokens: number

    The number of output tokens generated.

    server_tool_use: ServerToolUse { web_search_requests }

    Server-side tool usage metrics.

    web_search_requests: number

    The number of web search requests made.

    service_tier: "standard" | "batch" | "priority" | 3 more | null

    Service tier used. Null if not grouping by service tier.

    Accepts one of the following:
    "standard"
    "batch"
    "priority"
    "priority_on_demand"
    "flex"
    "flex_discount"
    uncached_input_tokens: number

    The number of uncached input tokens processed.

    workspace_id: string | null

    ID of the Workspace used. Null if not grouping by workspace or for the default workspace.

    starting_at: string

    Start of the time bucket (inclusive) in RFC 3339 format.

    formatdate-time
    has_more: boolean

    Indicates if there are more results.

    next_page: string | null

    Token to provide in as page in the subsequent request to retrieve the next page of data.

    formatdate-time

    AdminUsers

    Remove User
    client.admin.users.delete(stringuserID, RequestOptionsoptions?): UserDeleteResponse { id, type }
    delete/v1/organizations/users/{user_id}
    List Users
    client.admin.users.list(UserListParams { after_id, before_id, email, limit } query?, RequestOptionsoptions?): Page<User { id, added_at, email, 3 more } >
    get/v1/organizations/users
    Get User
    client.admin.users.retrieve(stringuserID, RequestOptionsoptions?): User { id, added_at, email, 3 more }
    get/v1/organizations/users/{user_id}
    Update User
    client.admin.users.update(stringuserID, UserUpdateParams { role } body, RequestOptionsoptions?): User { id, added_at, email, 3 more }
    post/v1/organizations/users/{user_id}
    ModelsExpand Collapse
    User { id, added_at, email, 3 more }
    id: string

    ID of the User.

    added_at: string

    RFC 3339 datetime string indicating when the User joined the Organization.

    formatdate-time
    email: string

    Email of the User.

    name: string

    Name of the User.

    role: "user" | "developer" | "billing" | 2 more

    Organization role of the User.

    Accepts one of the following:
    "user"
    "developer"
    "billing"
    "admin"
    "claude_code_user"
    type: "user"

    Object type.

    For Users, this is always "user".

    Accepts one of the following:
    "user"

    AdminWorkspaces

    Archive Workspace
    client.admin.workspaces.archive(stringworkspaceID, RequestOptionsoptions?): Workspace { id, archived_at, created_at, 3 more }
    post/v1/organizations/workspaces/{workspace_id}/archive
    Create Workspace
    client.admin.workspaces.create(WorkspaceCreateParams { name } body, RequestOptionsoptions?): Workspace { id, archived_at, created_at, 3 more }
    post/v1/organizations/workspaces
    List Workspaces
    client.admin.workspaces.list(WorkspaceListParams { after_id, before_id, include_archived, limit } query?, RequestOptionsoptions?): Page<Workspace { id, archived_at, created_at, 3 more } >
    get/v1/organizations/workspaces
    Get Workspace
    client.admin.workspaces.retrieve(stringworkspaceID, RequestOptionsoptions?): Workspace { id, archived_at, created_at, 3 more }
    get/v1/organizations/workspaces/{workspace_id}
    Update Workspace
    client.admin.workspaces.update(stringworkspaceID, WorkspaceUpdateParams { name } body, RequestOptionsoptions?): Workspace { id, archived_at, created_at, 3 more }
    post/v1/organizations/workspaces/{workspace_id}

    AdminWorkspacesMembers

    Create Workspace Member
    client.admin.workspaces.members.create(stringworkspaceID, MemberCreateParams { user_id, workspace_role } body, RequestOptionsoptions?): WorkspaceMember { type, user_id, workspace_id, workspace_role }
    post/v1/organizations/workspaces/{workspace_id}/members
    Delete Workspace Member
    client.admin.workspaces.members.delete(stringuserID, MemberDeleteParams { workspace_id } params, RequestOptionsoptions?): MemberDeleteResponse { type, user_id, workspace_id }
    delete/v1/organizations/workspaces/{workspace_id}/members/{user_id}
    List Workspace Members
    client.admin.workspaces.members.list(stringworkspaceID, MemberListParams { after_id, before_id, limit } query?, RequestOptionsoptions?): Page<WorkspaceMember { type, user_id, workspace_id, workspace_role } >
    get/v1/organizations/workspaces/{workspace_id}/members
    Get Workspace Member
    client.admin.workspaces.members.retrieve(stringuserID, MemberRetrieveParams { workspace_id } params, RequestOptionsoptions?): WorkspaceMember { type, user_id, workspace_id, workspace_role }
    get/v1/organizations/workspaces/{workspace_id}/members/{user_id}
    Update Workspace Member
    client.admin.workspaces.members.update(stringuserID, MemberUpdateParams { workspace_id, workspace_role } params, RequestOptionsoptions?): WorkspaceMember { type, user_id, workspace_id, workspace_role }
    post/v1/organizations/workspaces/{workspace_id}/members/{user_id}
    ModelsExpand Collapse
    WorkspaceMember { type, user_id, workspace_id, workspace_role }
    type: "workspace_member"

    Object type.

    For Workspace Members, this is always "workspace_member".

    Accepts one of the following:
    "workspace_member"
    user_id: string

    ID of the User.

    workspace_id: string

    ID of the Workspace.

    workspace_role: "workspace_user" | "workspace_developer" | "workspace_admin" | "workspace_billing"

    Role of the Workspace Member.

    Accepts one of the following:
    "workspace_user"
    "workspace_developer"
    "workspace_admin"
    "workspace_billing"
    © 2025 ANTHROPIC PBC

    Products

    • Claude
    • Claude Code
    • Max plan
    • Team plan
    • Enterprise plan
    • Download app
    • Pricing
    • Log in

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Claude Developer Platform

    • Overview
    • Developer docs
    • Pricing
    • Amazon Bedrock
    • Google Cloud’s Vertex AI
    • Console login

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy

    Products

    • Claude
    • Claude Code
    • Max plan
    • Team plan
    • Enterprise plan
    • Download app
    • Pricing
    • Log in

    Features

    • Claude and Slack
    • Claude in Excel

    Models

    • Opus
    • Sonnet
    • Haiku

    Solutions

    • AI agents
    • Code modernization
    • Coding
    • Customer support
    • Education
    • Financial services
    • Government
    • Life sciences

    Claude Developer Platform

    • Overview
    • Developer docs
    • Pricing
    • Amazon Bedrock
    • Google Cloud’s Vertex AI
    • Console login

    Learn

    • Blog
    • Catalog
    • Courses
    • Use cases
    • Connectors
    • Customer stories
    • Engineering at Anthropic
    • Events
    • Powered by Claude
    • Service partners
    • Startups program

    Company

    • Anthropic
    • Careers
    • Economic Futures
    • Research
    • News
    • Responsible Scaling Policy
    • Security and compliance
    • Transparency

    Help and security

    • Availability
    • Status
    • Support center

    Terms and policies

    • Privacy policy
    • Responsible disclosure policy
    • Terms of service: Commercial
    • Terms of service: Consumer
    • Usage policy
    © 2025 ANTHROPIC PBC