API / JOIN

HUB

API

Get a key at console.x.ai. The stills model is grok-imagine-image-2.0. Download the URL; it expires.

Get started and models

  1. APIAuthenticate with mTLSauthenticate-with-mtls
  2. APICall Grok 4.7 via the APIcall-grok-4-7-via-api
  3. APIDebug Grok API errorsdebug-grok-api-errors
  4. APIGet a model via the xAI APIget-a-model-via-xai-api
  5. APIList models via the xAI APIlist-models-via-xai-api
  6. APIMigrate retired Grok models before May 15 2026migrate-retired-models-may-15
  7. APISend a safety_identifier on Grok API requestssend-safety-identifier-on-grok-api
  8. APISend your first Grok API requestsend-a-first-api-request
  9. APIUse Grok on Google Cloud Vertex AIuse-grok-on-google-cloud-vertex-ai
  10. APIUse Grok on Microsoft Foundryuse-grok-on-microsoft-foundry
  11. APIUse the US regional API endpointuse-us-regional-api-endpoint
  12. APIUse the US regional xAI API endpointuse-us-regional-xai-api-endpoint

Console, keys and Management API

  1. APICheck API key propagation via the xAI Management APIcheck-api-key-propagation-via-management-api
  2. APICreate a management key in the xAI Consolecreate-a-management-key-in-xai-console
  3. APICreate an xAI API key via the Management APIcreate-an-xai-api-key-via-management-api
  4. APIDelete an xAI API key via the Management APIdelete-an-xai-api-key-via-management-api
  5. APIEnable Zero Data Retention in the xAI Consoleenable-zdr-in-xai-console
  6. APIEnable Zero Data Retention on the xAI Consoleenable-zero-data-retention-on-xai-console
  7. APIExplore API usage in the xAI Consoleexplore-api-usage-in-xai-console
  8. APIList API keys via the xAI Management APIlist-api-keys-via-management-api
  9. APIList audit events via the xAI Management APIlist-audit-events-via-xai-management-api
  10. APIList endpoint ACLs via the xAI Management APIlist-endpoint-acls-via-management-api
  11. APIList team models via the xAI Management APIlist-team-models-via-management-api
  12. APIManage API keys with the xAI Management APImanage-api-keys-with-xai-management-api
  13. APIRotate an xAI API key via the Management APIrotate-an-xai-api-key-via-management-api
  14. APIRotate or disable an xAI API key in the Consolerotate-or-disable-an-xai-api-key
  15. APIUpdate an xAI API key via the Management APIupdate-an-xai-api-key-via-management-api
  16. APIValidate a management key via the xAI Management APIvalidate-a-management-key-via-management-api
  17. APIView xAI Console audit logsview-xai-console-audit-logs

Console billing and spend

  1. APIAdd a payment method in the xAI Consoleadd-payment-method-in-xai-console
  2. APICheck prepaid credit balance via the xAI Management APIcheck-prepaid-credit-balance-via-management-api
  3. APIGet billing info via the xAI Management APIget-billing-info-via-management-api
  4. APIGet postpaid spending limits via the xAI Management APIget-postpaid-spending-limits-via-management-api
  5. APIGet usage analytics via the xAI Management APIget-usage-analytics-via-management-api
  6. APIList invoices via the xAI Management APIlist-invoices-via-xai-management-api
  7. APIList payment methods via the xAI Management APIlist-payment-methods-via-management-api
  8. APIPreview a postpaid invoice via the xAI Management APIpreview-postpaid-invoice-via-management-api
  9. APIPurchase prepaid credits on the xAI Consolepurchase-prepaid-credits-on-xai-console
  10. APIRaise the invoiced billing limit in the xAI Consoleraise-invoiced-billing-limit-in-xai-console
  11. APISet auto top-up on the xAI Consoleset-auto-top-up-on-xai-console
  12. APISet billing info via the xAI Management APIset-billing-info-via-management-api
  13. APISet postpaid spending limits via the xAI Management APIset-postpaid-spending-limits-via-management-api
  14. APISet the default payment method via the xAI Management APIset-default-payment-method-via-management-api
  15. APITop up prepaid credits via the xAI Management APItop-up-prepaid-credits-via-management-api
  16. APIUpdate billing address in the xAI Consoleupdate-billing-address-in-xai-console
  17. APIView invoices in the xAI Consoleview-invoices-in-xai-console

Responses, streaming and reasoning

  1. APIAnalyze an image with the Grok APIanalyze-an-image-with-grok-api
  2. APIChain Responses with previous_response_idchain-responses-with-previous-id
  3. APICompact a chat in place with the xAI SDKcompact-chat-in-place-with-xai-sdk
  4. APICreate embeddings with the Grok APIcreate-embeddings-with-grok-api
  5. APIDelete a stored responsedelete-a-stored-response
  6. APIDisable store on Responses requestsdisable-store-on-responses
  7. APIDrive Responses API over WebSocketuse-responses-api-over-websocket
  8. APIMigrate Chat Completions calls to Responsesmigrate-chat-completions-to-responses
  9. APIRetrieve a stored responseretrieve-a-stored-response
  10. APIReturn structured JSON from the Grok APIreturn-structured-json-from-grok-api
  11. APISet max_output_tokens on Responses APIset-max-output-tokens-on-responses
  12. APISet reasoning effort on grok-4.6set-reasoning-effort
  13. APIStream reasoning summaries on grok-4.6stream-reasoning-summaries
  14. APIStream structured outputs from the Grok APIstream-structured-outputs-from-grok-api
  15. APIStream text from the Grok APIstream-text-from-grok-api
  16. APIUnderstand an image with the Grok APIunderstand-an-image-with-grok-api
  17. APIUse context compactionuse-context-compaction
  18. APIUse encrypted reasoning contentuse-encrypted-reasoning-content
  1. APIAdd web search to a Grok API requestadd-web-search-to-an-api-request
  2. APICombine web search and code execution on the Grok APIcombine-web-search-and-code-execution
  3. APICombine web search and X search on the Grok APIcombine-web-search-and-x-search
  4. APICombine web search, X search, and code execution on the Grok APIcombine-web-search-x-search-and-code-execution
  5. APIEnable image search in web searchenable-image-search-in-web-search
  6. APIEnable image understanding in web searchenable-web-search-image-understanding
  7. APIEnable image understanding on X Searchenable-x-search-image-understanding
  8. APIEnable video understanding on X Searchenable-x-search-video-understanding
  9. APIExclude domains from web searchexclude-web-search-domains
  10. APIExclude handles from X Searchexclude-x-search-handles
  11. APIRestrict web search to allowed domainsrestrict-web-search-to-domains
  12. APIRestrict X Search to specific handlesrestrict-x-search-to-handles
  13. SearchSearch X posts with the Grok APIsearch-x-posts-with-grok-api
  14. APISet an X Search date rangeset-x-search-date-range

Functions, code execution and MCP tools

  1. APIAdd the xAI Docs MCP serveradd-xai-docs-mcp-server
  2. APICall a function with the Grok APIcall-a-function-with-grok-api
  3. APICall custom functions on the Grok APIcall-custom-functions-on-grok-api
  4. APICite tool sources in API responsescite-tool-sources-in-api-responses
  5. APICombine structured outputs with tools on the Grok APIcombine-structured-outputs-with-tools
  6. APIConnect a remote MCP server in the Grok APIconnect-remote-mcp-in-grok-api
  7. APIContinue agentic tool chats across turnscontinue-agentic-tools-across-turns
  8. APIContinue an agentic conversation with store_messagescontinue-agentic-conversation-with-store-messages
  9. APIDisable parallel tool callsdisable-parallel-tool-calls
  10. APIExecute code with the Grok APIexecute-code-with-grok-api
  11. APIForce a specific tool with tool_choiceforce-a-specific-tool-with-tool-choice
  12. APIInclude an image in an agentic tool requestinclude-an-image-in-an-agentic-tool-request
  13. APIInclude images in agentic tool conversationsinclude-images-in-agentic-tool-calls
  14. APILimit agentic tool turns with max_turnslimit-agentic-turns-with-max-turns
  15. APIMix client-side and server-side tools on Grokmix-client-and-server-side-tools
  16. APIRead server-side tool usage on Grok API responsesread-server-side-tool-usage
  17. APIRun code execution on the Grok APIrun-code-execution-on-grok-api
  18. APIRun multi-agent research on grok-4.20-multi-agentrun-multi-agent-research
  19. APISet max_turns on agentic Responsesset-max-turns-on-agentic-responses
  20. APIStream agentic tool calls on the Grok APIstream-agentic-tool-calls
  21. APIUse encrypted content for agentic multi-turnuse-encrypted-content-for-agentic-multi-turn

Files and Collections

  1. APIAttach files to a Grok chat requestattach-files-to-a-chat-request
  2. APIBatch-get collection document metadatabatch-get-collection-documents
  3. APIChat with files on the Grok APIchat-with-files-on-grok-api
  4. APICombine collections search with web and X searchcombine-collections-search-with-web-and-x-search
  5. APICompare Files API and Collections size limitscompare-files-and-collections-limits
  6. APICreate a collection and upload documents via APIcreate-a-collection-via-api
  7. APICreate a public URL for a Files API filecreate-a-file-public-url
  8. APIDelete a collection via the Management APIdelete-a-collection-via-api
  9. APIDelete a document from a Grok collectiondelete-a-document-from-a-collection
  10. APIFilter Files API listings with AIP-160filter-files-with-aip-160
  11. APIGet Files API metadata and check expiryget-files-api-metadata
  12. APIList and poll documents in a Grok collectionlist-and-poll-collection-documents
  13. APIList collections via the Management APIlist-collections-via-api
  14. APIList Files API uploads that have a public URLlist-files-with-public-url-filter
  15. APIList, download, and delete Files API uploadslist-download-delete-files-on-grok-api
  16. APIList, update, and delete collections via APIlist-update-delete-collections-via-api
  17. APIReindex a document in a Grok collectionreindex-a-collection-document
  18. APISearch collections with the Grok APIsearch-collections-with-grok-api
  19. APISet a TTL on Files API uploadsset-files-api-ttl
  20. APISet chunk configuration on a Grok collectionset-chunk-configuration-on-a-collection
  21. APISet collection metadata fields and filter searchset-collection-metadata-fields
  22. APISet keyword, semantic, or hybrid retrieval on collection searchset-retrieval-mode-on-collection-search
  23. APIStream-download Files API content to diskstream-download-files-api-content
  24. APITrack Files API upload progress with on_progresstrack-files-api-upload-progress
  25. APIUpdate a collection via the Management APIupdate-a-collection-via-api
  26. APIUpload a document to a Collections collectionupload-a-document-to-a-collection
  27. APIUpload Files API content from bytes or a file handleupload-files-from-bytes

Batch, cost, caching and limits

  1. APIAdd Batch API requests from a JSONL fileadd-requests-to-a-batch-via-jsonl
  2. APIAvoid breaking Grok API prompt cacheavoid-breaking-prompt-cache
  3. APICancel a Batch API jobcancel-a-batch-api-job
  4. APIGet Batch API cost breakdownget-batch-cost-breakdown
  5. APIGet Batch API resultsget-batch-api-results
  6. APIHandle Grok API rate limitshandle-grok-api-rate-limits
  7. APIInspect Batch API request metadatainspect-batch-request-metadata
  8. APIList batches via the xAI APIlist-batches-via-xai-api
  9. APIMaximize Grok API prompt cache hitsmaximize-prompt-cache-hits
  10. APIPrepare for the X Search tool pricing changeprepare-for-x-search-pricing-change
  11. APIRead API request cost in usd ticksread-api-request-cost-in-usd-ticks
  12. APIRead cost_in_usd_ticks on Grok API responsesread-cost-in-usd-ticks
  13. APIRun a Batch API jobrun-a-batch-api-job
  14. APIRun a deferred Grok chat completionrun-deferred-chat-completion
  15. APISend async concurrent Grok API requestssend-async-concurrent-requests
  16. APITrack request cost in usd tickstrack-request-cost-in-usd-ticks
  17. APIUnderstand long-context pricing on the Grok APIunderstand-long-context-pricing
  18. APIUse priority processinguse-priority-processing

Imagine API: images

  1. APIAdd Imagine image and video jobs to a Batch API queueadd-imagine-jobs-to-a-batch
  2. APIAnimate a still with the Imagine APIanimate-a-still-with-imagine-api
  3. APIChain multi-turn edits with the image generation toolchain-multi-turn-edits-with-image-generation-tool
  4. APICheck respect_moderation on Imagine imagecheck-respect-moderation-on-imagine-image
  5. APICombine web search and the image generation toolcombine-web-search-and-image-generation-tool
  6. APIConfigure image generation tool actionconfigure-image-generation-tool-action
  7. APIEdit an image with the Imagine APIedit-an-image-with-imagine-api
  8. APIEdit multiple images with the Imagine APIedit-multiple-images-with-imagine-api
  9. APIEdit with multiple source images on Imaginemulti-image-editing-with-imagine
  10. APIGenerate a still with the Imagine Image 2.0 APIgenerate-a-still-with-imagine-api
  11. APIGenerate image variations with the Imagine APIgenerate-image-variations-with-imagine-api
  12. APIGenerate Imagine API images as base64generate-imagine-api-images-as-base64
  13. APIMigrate from grok-imagine-image-quality before November 2migrate-from-grok-imagine-image-quality
  14. APIPersist an Imagine output with a public URLpersist-imagine-public-url
  15. APIRun concurrent Imagine image generationsrun-concurrent-imagine-image-generations
  16. APISet aspect ratio on Imagine API imagesset-aspect-ratio-on-imagine-api-images
  17. APISet image quality via the Imagine APIset-image-quality-via-imagine-api
  18. APISet Imagine storage and public URL expiry knobsset-imagine-storage-expiry-knobs
  19. APISet quality on grok-imagine-image-2.0set-quality-on-grok-imagine-image-2
  20. APISet resolution on Imagine API imagesset-resolution-on-imagine-api-images
  21. APIStream image generation tool progressstream-image-generation-tool-progress
  22. APIUse Files API file IDs as Imagine inputsuse-files-api-as-imagine-inputs
  23. APIUse the Files API with Imagineuse-files-api-with-imagine
  24. APIUse the image generation tool in a conversationuse-image-generation-tool

Imagine API: video

  1. APIAdd preset voices to Imagine reference-to-videoadd-preset-voices-to-imagine-video
  2. APIAdd spoken dialogue with reference_audios on Imagine videoadd-spoken-dialogue-with-reference-audios
  3. APIAnimate an image to video with the Imagine APIanimate-image-to-video-with-imagine-api
  4. APIBranch Imagine video edits from an intermediate clipbranch-imagine-video-edits-from-intermediate
  5. APICheck respect_moderation on Imagine videocheck-respect-moderation-on-imagine-video
  6. APICustomize Imagine video SDK poll timeout and intervalcustomize-imagine-video-poll-timeout
  7. APIDisable audio on Imagine video generationdisable-audio-on-imagine-video
  8. APIEdit a video with the Imagine APIedit-a-video-with-imagine-api
  9. APIExtend an Imagine video with the APIextend-an-imagine-video-api
  10. APIGenerate 1080p Imagine video with the APIgenerate-1080p-imagine-video
  11. APIGenerate a video from reference imagesgenerate-reference-to-video
  12. APIGenerate a video from text with the Imagine APIgenerate-video-from-text-with-imagine-api
  13. APIGenerate text-to-video with the Imagine APIgenerate-text-to-video-with-imagine-api
  14. APIHandle Imagine video generation errorshandle-imagine-video-generation-errors
  15. APIPin first and last frames on Imagine video 1.5pin-first-and-last-frame-on-imagine-video
  16. APIPin keyframes on Imagine video 1.5pin-keyframes-on-imagine-video
  17. APIPoll Imagine video manually with start and getpoll-imagine-video-manually
  18. APIRead Imagine video progress while pollingread-imagine-video-progress-while-polling
  19. APIRun concurrent Imagine video edits from one sourceconcurrent-imagine-video-edits
  20. APIRun concurrent Imagine video generationsconcurrent-imagine-video-generations
  21. APISend an Imagine video to your upload URLsend-imagine-video-to-your-upload-url
  22. APISet aspect ratio on Imagine video generationset-imagine-video-aspect-ratio
  23. APISet duration on Imagine API videosset-duration-on-imagine-api-videos
  24. APISet resolution on Imagine API videosset-resolution-on-imagine-api-videos
  25. APIStore an Imagine API video with storage_optionsstore-imagine-video-output-with-storage-options

Origin repos and contents

  1. APIBatch Get Origin Contents via the APIbatch-get-origin-contents-via-api
  2. APICreate an Origin Label via the APIcreate-origin-label-via-api
  3. APICreate an Origin Repo via the APIcreate-origin-repo-via-api
  4. APIDelete an Origin Label via the APIdelete-origin-label-via-api
  5. APIDownload an Origin Repo Tarball via the APIdownload-origin-repo-tarball-via-api
  6. APIGet an Origin Label via the APIget-origin-label-via-api
  7. APIGet an Origin Repo via the APIget-origin-repo-via-api
  8. APIGet Origin Contents via the APIget-origin-contents-via-api
  9. APIGrep Origin Contents via the APIgrep-origin-contents-via-api
  10. APIList Origin Labels via the APIlist-origin-labels-via-api
  11. APIList Origin Repos via the APIlist-origin-repos-via-api
  12. APIList Owner Origin Repos via the APIlist-owner-origin-repos-via-api
  13. APIUpdate an Origin Label via the APIupdate-origin-label-via-api
  14. APIUpdate an Origin Repo via the APIupdate-origin-repo-via-api

Origin commits, refs and git data

  1. APICompare Origin Commits via the APIcompare-origin-commits-via-api
  2. APICreate Origin Commit From Files via the APIcreate-origin-commit-from-files-via-api
  3. APICreate Origin Git Ref via the APIcreate-origin-git-ref-via-api
  4. APIDelete Origin Git Ref via the APIdelete-origin-git-ref-via-api
  5. APIGet an Origin Commit via the APIget-origin-commit-via-api
  6. APIGet Origin Blob via the APIget-origin-blob-via-api
  7. APIGet Origin Git Commit via the APIget-origin-git-commit-via-api
  8. APIGet Origin Git Ref via the APIget-origin-git-ref-via-api
  9. APIGet Origin Tag via the APIget-origin-tag-via-api
  10. APIGet Origin Tree via the APIget-origin-tree-via-api
  11. APIList Origin Branches via the APIlist-origin-branches-via-api
  12. APIList Origin Commit Files via the APIlist-origin-commit-files-via-api
  13. APIList Origin Commits via the APIlist-origin-commits-via-api
  14. APIList Origin Comparison Files via the APIlist-origin-comparison-files-via-api
  15. APIList Origin Matching Git Refs via the APIlist-origin-matching-git-refs-via-api
  16. APIList Origin Repo Branches via the APIlist-origin-repo-branches-via-api

Origin pull requests

  1. APICreate an Origin Pull Request via the APIcreate-origin-pull-request-via-api
  2. APIFilter Origin Pull Requests by Head SHA via the APIfilter-origin-pull-requests-by-head-sha-via-api
  3. APIGet an Origin Pull Request via the APIget-origin-pull-request-via-api
  4. APIGet Origin Pull Request Mergeability via the APIget-origin-pull-request-mergeability-via-api
  5. APIList Origin Pull Request Commits via the APIlist-origin-pull-request-commits-via-api
  6. APIList Origin Pull Request Files via the APIlist-origin-pull-request-files-via-api
  7. APIList Origin Pull Requests via the APIlist-origin-pull-requests-via-api
  8. APIMerge an Origin Pull Request via the APImerge-origin-pull-request-via-api
  9. APIStack Origin Pull Requests via the APIstack-origin-pull-requests-via-api
  10. APIUpdate an Origin Pull Request Thread via the APIupdate-origin-pull-request-thread-via-api
  11. APIUpdate an Origin Pull Request via the APIupdate-origin-pull-request-via-api

Origin PR reviews, comments and labels

  1. APIAdd Origin Pull Request Labels via the APIadd-origin-pull-request-labels-via-api
  2. APICreate an Origin Pull Request Comment via the APIcreate-origin-pull-request-comment-via-api
  3. APICreate an Origin Pull Request Review via the APIcreate-origin-pull-request-review-via-api
  4. APIDelete an Origin Pull Request Comment via the APIdelete-origin-pull-request-comment-via-api
  5. APIDismiss an Origin Pull Request Review via the APIdismiss-origin-pull-request-review-via-api
  6. APIGet an Origin Pull Request Comment via the APIget-origin-pull-request-comment-via-api
  7. APIList Origin Pull Request Comments via the APIlist-origin-pull-request-comments-via-api
  8. APIList Origin Pull Request Labels via the APIlist-origin-pull-request-labels-via-api
  9. APIList Origin Pull Request Requested Reviewers via the APIlist-origin-pull-request-requested-reviewers-via-api
  10. APIList Origin Pull Request Reviews via the APIlist-origin-pull-request-reviews-via-api
  11. APIRemove All Origin Pull Request Labels via the APIremove-all-origin-pull-request-labels-via-api
  12. APIRemove an Origin Pull Request Label via the APIremove-origin-pull-request-label-via-api
  13. APIRemove Origin Pull Request Requested Reviewers via the APIremove-origin-pull-request-requested-reviewers-via-api
  14. APIRequest Origin Pull Request Reviewers via the APIrequest-origin-pull-request-reviewers-via-api
  15. APISet Origin Pull Request Labels via the APIset-origin-pull-request-labels-via-api
  16. APIUpdate an Origin Pull Request Comment via the APIupdate-origin-pull-request-comment-via-api
  17. APIUpdate an Origin Pull Request Review via the APIupdate-origin-pull-request-review-via-api

Origin check runs

  1. APIBatch Upsert Origin Check Runs via the APIbatch-upsert-origin-check-runs-via-api
  2. APICreate Origin Check Run Annotations via the APIcreate-origin-check-run-annotations-via-api
  3. APIGet an Origin Check Run via the APIget-origin-check-run-via-api
  4. APIGet an Origin Check Suite via the APIget-origin-check-suite-via-api
  5. APIList Origin Check Run Annotations via the APIlist-origin-check-run-annotations-via-api
  6. APIList Origin Check Runs for a Commit via the APIlist-origin-check-runs-for-commit-via-api
  7. APIList Origin Check Runs for a Suite via the APIlist-origin-check-runs-for-suite-via-api
  8. APIList Origin Check Suites for a Commit via the APIlist-origin-check-suites-for-commit-via-api
  9. APIRead Origin Check Run Upsert Outcome via the APIread-origin-check-run-upsert-outcome-via-api
  10. APIRerequest an Origin Check Run via the APIrerequest-origin-check-run-via-api
  11. APIUpsert an Origin Check Run via the APIupsert-origin-check-run-via-api
  12. APIUse Markdown in Origin check run annotation messagesuse-markdown-in-origin-check-run-annotation-messages

Origin webhooks

  1. APIBatch-redeliver and ping Origin webhooks via the APIbatch-redeliver-and-ping-origin-webhooks-via-api
  2. APIHandle Origin check run created and completed webhookshandle-origin-check-run-webhooks
  3. APIHandle Origin check run rerequested webhookshandle-origin-check-run-rerequested-webhooks
  4. APIHandle Origin installation webhookshandle-origin-installation-webhooks
  5. APIHandle Origin pull request comment created webhookshandle-origin-pull-request-comment-webhooks
  6. APIHandle Origin pull request comment reaction webhookshandle-origin-pull-request-comment-reaction-webhooks
  7. APIHandle Origin pull request label webhookshandle-origin-pull-request-label-webhooks
  8. APIHandle Origin pull request lifecycle webhookshandle-origin-pull-request-webhooks
  9. APIHandle Origin pull request review webhookshandle-origin-pull-request-review-webhooks
  10. APIHandle Origin pull request reviewer webhookshandle-origin-pull-request-reviewer-webhooks
  11. APIHandle Origin repository webhookshandle-origin-repository-webhooks
  12. APIList Origin webhook deliveries via the APIlist-origin-webhook-deliveries-via-api

Origin apps and installations

  1. APIAdd and revoke Origin App signing keys via the APIadd-and-revoke-origin-app-signing-keys-via-api
  2. APIAdd Origin App Installation Repositories via the APIadd-origin-installation-repos-via-api
  3. APIAdd Repositories to an Origin App Installation via the APIadd-repos-to-origin-app-installation-via-api
  4. APICreate an Origin App via the APIcreate-origin-app-via-api
  5. APICreate an Origin installation access token via the APIcreate-origin-installation-access-token-via-api
  6. APIDelete an Origin App installation via the APIdelete-origin-app-installation-via-api
  7. APIGet and update an Origin App via the APIget-and-update-origin-app-via-api
  8. APIGet the authenticated Origin App via the APIget-authenticated-origin-app-via-api
  9. APIList and get Origin App installations via the APIlist-and-get-origin-app-installations-via-api
  10. APIList Origin Apps in a namespace via the APIlist-namespace-origin-apps-via-api
  11. APIList Origin installation repositories via the APIlist-origin-installation-repos-via-api

Origin grants, rulesets, SSH CAs and mirrors

  1. APIAdd an Origin SSH Certificate Authority via the APIadd-origin-ssh-certificate-authority-via-api
  2. APICreate Origin Ruleset via the APIcreate-origin-ruleset-via-api
  3. APIDelete an Origin Namespace Grant via the APIdelete-origin-namespace-grant-via-api
  4. APIDelete an Origin Repository Grant via the APIdelete-origin-repository-grant-via-api
  5. APIDelete an Origin SSH Certificate Authority via the APIdelete-origin-ssh-certificate-authority-via-api
  6. APIDelete Origin Ruleset via the APIdelete-origin-ruleset-via-api
  7. APIDetach an Origin repo mirror via the Migration APIdetach-origin-repo-mirror-via-api
  8. APIForce an Origin repo mirror cutover via the Migration APIforce-origin-repo-mirror-cutover-via-api
  9. APIGet Origin rate limit status via the APIget-origin-rate-limit-via-api
  10. APIGet Origin Ruleset via the APIget-origin-ruleset-via-api
  11. APIList Origin Namespace Grants via the APIlist-origin-namespace-grants-via-api
  12. APIList Origin Repository Grants via the APIlist-origin-repository-grants-via-api
  13. APIList Origin Rulesets via the APIlist-origin-rulesets-via-api
  14. APIList Origin SSH Certificate Authorities via the APIlist-origin-ssh-certificate-authorities-via-api
  15. APIPoll Origin mirror transition jobs via the Migration APIpoll-origin-mirror-transition-jobs-via-api
  16. APISet Origin SSH Certificate Requirement via the APIset-origin-ssh-certificate-requirement-via-api
  17. APISync an Origin Repo Mirror via the APIsync-origin-repo-mirror-via-api
  18. APITransition an Origin repo mirror via the Migration APItransition-origin-repo-mirror-via-api
  19. APIUpdate Origin Ruleset via the APIupdate-origin-ruleset-via-api
  20. APIUpsert an Origin Namespace Grant via the APIupsert-origin-namespace-grant-via-api
  21. APIUpsert an Origin Repository Grant via the APIupsert-origin-repository-grant-via-api

Cloud Agents and worker pools

  1. APIArchive and unarchive a Cloud Agent via APIarchive-and-unarchive-a-cloud-agent-via-api
  2. APIClaim a pending pool request via the Cloud Agents APIclaim-a-pending-pool-request-via-api
  3. APICreate a Cloud Agent with the Cloud Agents APIcreate-a-cloud-agent-via-api
  4. APICreate a user-scoped worker token via the Cloud Agents APIcreate-a-user-scoped-worker-token-via-api
  5. APICreate and list Cloud Agent runs with the Cloud Agents APIcreate-and-list-cloud-agent-runs-via-api
  6. APIDelete a Cloud Agent permanently via APIdelete-a-cloud-agent-via-api
  7. APIDeregister a pool via the Cloud Agents APIderegister-a-pool-via-api
  8. APIGet API key info via the Cloud Agents APIget-api-key-info-via-cloud-agents-api
  9. APIGet Cloud Agent usage via APIget-cloud-agent-usage-via-api
  10. APIGet pool worker by ID via the Cloud Agents APIget-pool-worker-by-id-via-api
  11. APIGet pool worker summary via the Cloud Agents APIget-pool-worker-summary-via-api
  12. APIList and download Cloud Agent artifacts via APIlist-and-download-cloud-agent-artifacts-via-api
  13. APIList and get Cloud Agents with the Cloud Agents APIlist-and-get-cloud-agents-via-api
  14. APIList and register pools via the Cloud Agents APIlist-and-register-pools-via-api
  15. APIList GitHub repositories via the Cloud Agents APIlist-github-repositories-via-cloud-agents-api
  16. APIList models via the Cloud Agents APIlist-models-via-cloud-agents-api
  17. APIList pending pool requests via the Cloud Agents APIlist-pending-pool-requests-via-api
  18. APIList pool workers via the Cloud Agents APIlist-pool-workers-via-api
  19. APIRelease a pool request claim via the Cloud Agents APIrelease-a-pool-request-claim-via-api
  20. APIStream and cancel a Cloud Agent run with the Cloud Agents APIstream-and-cancel-a-cloud-agent-run-via-api
  21. APIWatch pending pool requests via the Cloud Agents APIwatch-pending-pool-requests-via-api

Analytics and AI code metrics

  1. APIDownload AI commit metrics CSV with the AI Code Tracking APIdownload-ai-commit-metrics-csv-via-api
  2. APIGet agent edits with the Analytics APIget-agent-edits-via-analytics-api
  3. APIGet AI code change metrics with the AI Code Tracking APIget-ai-code-change-metrics-via-api
  4. APIGet AI commit details with the AI Code Tracking APIget-ai-commit-details-via-api
  5. APIGet AI commit metrics with the AI Code Tracking APIget-ai-commit-metrics-via-api
  6. APIGet Ask mode adoption with the Analytics APIget-ask-mode-adoption-via-analytics-api
  7. APIGet Bugbot PR analytics with the Analytics APIget-bugbot-analytics-via-analytics-api
  8. APIGet Bugbot review analytics with the Analytics APIget-bugbot-reviews-via-analytics-api
  9. APIGet by-user metrics with the Analytics APIget-by-user-metrics-via-analytics-api
  10. APIGet client versions with the Analytics APIget-client-versions-via-analytics-api
  11. APIGet commands adoption with the Analytics APIget-commands-adoption-via-analytics-api
  12. APIGet Conversation Insights with the Analytics APIget-conversation-insights-via-analytics-api
  13. APIGet daily active users with the Analytics APIget-daily-active-users-via-analytics-api
  14. APIGet MCP adoption with the Analytics APIget-mcp-adoption-via-analytics-api
  15. APIGet model usage with the Analytics APIget-model-usage-via-analytics-api
  16. APIGet Plans adoption with the Analytics APIget-plans-adoption-via-analytics-api
  17. APIGet Skills adoption with the Analytics APIget-skills-adoption-via-analytics-api
  18. APIGet tab usage with the Analytics APIget-tab-usage-via-analytics-api
  19. APIGet the team leaderboard with the Analytics APIget-leaderboard-via-analytics-api
  20. APIGet top file extensions with the Analytics APIget-top-file-extensions-via-analytics-api