Skip to content
RunAPI Developer Docs
EN 中文
API Reference
QuickstartGuides · Getting started Before you startQuickstart Create an API keyQuickstart Verify your connectionQuickstart Choose an API familyQuickstart Prepare for productionQuickstart AuthenticationGuides · Getting started Choose the right keyAuthentication Create an API keyAuthentication Authenticate a requestAuthentication Keep keys secureAuthentication Troubleshoot authenticationAuthentication Task API quickstartGuides · Task API Create a TaskTask API quickstart Poll a TaskTask API quickstart Handle completionTask API quickstart Handle failureTask API quickstart Receive a callbackTask API quickstart LLM API quickstartGuides · LLM API Choose a protocolLLM API quickstart Send a requestLLM API quickstart Stream outputLLM API quickstart Handle errors and usageLLM API quickstart Platform Management quickstartGuides · Platform Management Create a management keyPlatform Management quickstart List standard API keysPlatform Management quickstart Create and rotate a keyPlatform Management quickstart Apply guardrailsPlatform Management quickstart Handle management errorsPlatform Management quickstart SDKsDeveloper Resources · SDKs & CLI Install a model SDKSDKs Authenticate the clientSDKs Work with asynchronous TasksSDKs Choose the next workflowSDKs CLIDeveloper Resources · SDKs & CLI Install the CLICLI AuthenticateCLI Inspect an operationCLI Run and wait for a TaskCLI Inspect a Task laterCLI Connect CC Switch to RunAPIDeveloper Resources · Tool Integrations Before you beginConnect CC Switch to RunAPI Install CC SwitchConnect CC Switch to RunAPI Add a RunAPI ProviderConnect CC Switch to RunAPI Verify the connectionConnect CC Switch to RunAPI TroubleshootConnect CC Switch to RunAPI Kling Text-to-VideoAPI Reference OverviewKling Text-to-Video EndpointKling Text-to-Video Supported modelsKling Text-to-Video Request schemaKling Text-to-Video Create acceptanceKling Text-to-Video Polling processingKling Text-to-Video Polling completedKling Text-to-Video Polling failedKling Text-to-Video Customer callback: completedKling Text-to-Video Customer callback: failedKling Text-to-Video ErrorsKling Text-to-Video Generated Code SamplesKling Text-to-Video Related GuidesKling Text-to-Video HappyHorse Edit-VideoAPI Reference OverviewHappyHorse Edit-Video EndpointHappyHorse Edit-Video Supported modelsHappyHorse Edit-Video Request schemaHappyHorse Edit-Video Create acceptanceHappyHorse Edit-Video Polling processingHappyHorse Edit-Video Polling completedHappyHorse Edit-Video Polling failedHappyHorse Edit-Video Customer callback: completedHappyHorse Edit-Video Customer callback: failedHappyHorse Edit-Video ErrorsHappyHorse Edit-Video Generated Code SamplesHappyHorse Edit-Video Related GuidesHappyHorse Edit-Video HappyHorse Image-to-VideoAPI Reference OverviewHappyHorse Image-to-Video EndpointHappyHorse Image-to-Video Supported modelsHappyHorse Image-to-Video Request schemaHappyHorse Image-to-Video Create acceptanceHappyHorse Image-to-Video Polling processingHappyHorse Image-to-Video Polling completedHappyHorse Image-to-Video Polling failedHappyHorse Image-to-Video Customer callback: completedHappyHorse Image-to-Video Customer callback: failedHappyHorse Image-to-Video ErrorsHappyHorse Image-to-Video Generated Code SamplesHappyHorse Image-to-Video Related GuidesHappyHorse Image-to-Video HappyHorse Text-to-VideoAPI Reference OverviewHappyHorse Text-to-Video EndpointHappyHorse Text-to-Video Supported modelsHappyHorse Text-to-Video Request schemaHappyHorse Text-to-Video Create acceptanceHappyHorse Text-to-Video Polling processingHappyHorse Text-to-Video Polling completedHappyHorse Text-to-Video Polling failedHappyHorse Text-to-Video Customer callback: completedHappyHorse Text-to-Video Customer callback: failedHappyHorse Text-to-Video ErrorsHappyHorse Text-to-Video Generated Code SamplesHappyHorse Text-to-Video Related GuidesHappyHorse Text-to-Video Wan AnimateAPI Reference OverviewWan Animate EndpointWan Animate Supported modelsWan Animate Request schemaWan Animate Create acceptanceWan Animate Polling processingWan Animate Polling completedWan Animate Polling failedWan Animate Customer callback: completedWan Animate Customer callback: failedWan Animate ErrorsWan Animate Generated Code SamplesWan Animate Related GuidesWan Animate Wan Edit-VideoAPI Reference OverviewWan Edit-Video EndpointWan Edit-Video Supported modelsWan Edit-Video Request schemaWan Edit-Video Create acceptanceWan Edit-Video Polling processingWan Edit-Video Polling completedWan Edit-Video Polling failedWan Edit-Video Customer callback: completedWan Edit-Video Customer callback: failedWan Edit-Video ErrorsWan Edit-Video Generated Code SamplesWan Edit-Video Related GuidesWan Edit-Video Wan Image-to-VideoAPI Reference OverviewWan Image-to-Video EndpointWan Image-to-Video Supported modelsWan Image-to-Video Request schemaWan Image-to-Video Create acceptanceWan Image-to-Video Polling processingWan Image-to-Video Polling completedWan Image-to-Video Polling failedWan Image-to-Video Customer callback: completedWan Image-to-Video Customer callback: failedWan Image-to-Video ErrorsWan Image-to-Video Generated Code SamplesWan Image-to-Video Related GuidesWan Image-to-Video Wan Speech-to-VideoAPI Reference OverviewWan Speech-to-Video EndpointWan Speech-to-Video Supported modelsWan Speech-to-Video Request schemaWan Speech-to-Video Create acceptanceWan Speech-to-Video Polling processingWan Speech-to-Video Polling completedWan Speech-to-Video Polling failedWan Speech-to-Video Customer callback: completedWan Speech-to-Video Customer callback: failedWan Speech-to-Video ErrorsWan Speech-to-Video Generated Code SamplesWan Speech-to-Video Related GuidesWan Speech-to-Video Wan Text-to-ImageAPI Reference OverviewWan Text-to-Image EndpointWan Text-to-Image Supported modelsWan Text-to-Image Request schemaWan Text-to-Image Create acceptanceWan Text-to-Image Polling processingWan Text-to-Image Polling completedWan Text-to-Image Polling failedWan Text-to-Image Customer callback: completedWan Text-to-Image Customer callback: failedWan Text-to-Image ErrorsWan Text-to-Image Generated Code SamplesWan Text-to-Image Related GuidesWan Text-to-Image Wan Text-to-VideoAPI Reference OverviewWan Text-to-Video EndpointWan Text-to-Video Supported modelsWan Text-to-Video Request schemaWan Text-to-Video Create acceptanceWan Text-to-Video Polling processingWan Text-to-Video Polling completedWan Text-to-Video Polling failedWan Text-to-Video Customer callback: completedWan Text-to-Video Customer callback: failedWan Text-to-Video ErrorsWan Text-to-Video Generated Code SamplesWan Text-to-Video Related GuidesWan Text-to-Video Seedance Text-to-VideoAPI Reference OverviewSeedance Text-to-Video EndpointSeedance Text-to-Video Supported modelsSeedance Text-to-Video Request schemaSeedance Text-to-Video Create acceptanceSeedance Text-to-Video Polling processingSeedance Text-to-Video Polling completedSeedance Text-to-Video Polling failedSeedance Text-to-Video Customer callback: completedSeedance Text-to-Video Customer callback: failedSeedance Text-to-Video ErrorsSeedance Text-to-Video Generated Code SamplesSeedance Text-to-Video Related GuidesSeedance Text-to-Video OmniHuman Audio-to-VideoAPI Reference OverviewOmniHuman Audio-to-Video EndpointOmniHuman Audio-to-Video Supported modelsOmniHuman Audio-to-Video Request schemaOmniHuman Audio-to-Video Create acceptanceOmniHuman Audio-to-Video Polling processingOmniHuman Audio-to-Video Polling completedOmniHuman Audio-to-Video Polling failedOmniHuman Audio-to-Video Customer callback: completedOmniHuman Audio-to-Video Customer callback: failedOmniHuman Audio-to-Video ErrorsOmniHuman Audio-to-Video Generated Code SamplesOmniHuman Audio-to-Video Related GuidesOmniHuman Audio-to-Video OmniHuman Human-IdentificationAPI Reference OverviewOmniHuman Human-Identification EndpointOmniHuman Human-Identification Supported modelsOmniHuman Human-Identification Request schemaOmniHuman Human-Identification Create acceptanceOmniHuman Human-Identification Polling processingOmniHuman Human-Identification Polling completedOmniHuman Human-Identification Polling failedOmniHuman Human-Identification Customer callback: completedOmniHuman Human-Identification Customer callback: failedOmniHuman Human-Identification ErrorsOmniHuman Human-Identification Generated Code SamplesOmniHuman Human-Identification Related GuidesOmniHuman Human-Identification OmniHuman Subject-DetectionAPI Reference OverviewOmniHuman Subject-Detection EndpointOmniHuman Subject-Detection Supported modelsOmniHuman Subject-Detection Request schemaOmniHuman Subject-Detection Create acceptanceOmniHuman Subject-Detection Polling processingOmniHuman Subject-Detection Polling completedOmniHuman Subject-Detection Polling failedOmniHuman Subject-Detection Customer callback: completedOmniHuman Subject-Detection Customer callback: failedOmniHuman Subject-Detection ErrorsOmniHuman Subject-Detection Generated Code SamplesOmniHuman Subject-Detection Related GuidesOmniHuman Subject-Detection Volcengine Lip Sync Lip-Sync-VideoAPI Reference OverviewVolcengine Lip Sync Lip-Sync-Video EndpointVolcengine Lip Sync Lip-Sync-Video Supported modelsVolcengine Lip Sync Lip-Sync-Video Request schemaVolcengine Lip Sync Lip-Sync-Video Create acceptanceVolcengine Lip Sync Lip-Sync-Video Polling processingVolcengine Lip Sync Lip-Sync-Video Polling completedVolcengine Lip Sync Lip-Sync-Video Polling failedVolcengine Lip Sync Lip-Sync-Video Customer callback: completedVolcengine Lip Sync Lip-Sync-Video Customer callback: failedVolcengine Lip Sync Lip-Sync-Video ErrorsVolcengine Lip Sync Lip-Sync-Video Generated Code SamplesVolcengine Lip Sync Lip-Sync-Video Related GuidesVolcengine Lip Sync Lip-Sync-Video Veo 3.1 Extend-VideoAPI Reference OverviewVeo 3.1 Extend-Video EndpointVeo 3.1 Extend-Video Supported modelsVeo 3.1 Extend-Video Request schemaVeo 3.1 Extend-Video Create acceptanceVeo 3.1 Extend-Video Polling processingVeo 3.1 Extend-Video Polling completedVeo 3.1 Extend-Video Polling failedVeo 3.1 Extend-Video Customer callback: completedVeo 3.1 Extend-Video Customer callback: failedVeo 3.1 Extend-Video ErrorsVeo 3.1 Extend-Video Generated Code SamplesVeo 3.1 Extend-Video Related GuidesVeo 3.1 Extend-Video Veo 3.1 Text-to-VideoAPI Reference OverviewVeo 3.1 Text-to-Video EndpointVeo 3.1 Text-to-Video Supported modelsVeo 3.1 Text-to-Video Request schemaVeo 3.1 Text-to-Video Create acceptanceVeo 3.1 Text-to-Video Polling processingVeo 3.1 Text-to-Video Polling completedVeo 3.1 Text-to-Video Polling failedVeo 3.1 Text-to-Video Customer callback: completedVeo 3.1 Text-to-Video Customer callback: failedVeo 3.1 Text-to-Video ErrorsVeo 3.1 Text-to-Video Generated Code SamplesVeo 3.1 Text-to-Video Related GuidesVeo 3.1 Text-to-Video Veo 3.1 Upscale-VideoAPI Reference OverviewVeo 3.1 Upscale-Video EndpointVeo 3.1 Upscale-Video Supported modelsVeo 3.1 Upscale-Video Request schemaVeo 3.1 Upscale-Video Create acceptanceVeo 3.1 Upscale-Video Polling processingVeo 3.1 Upscale-Video Polling completedVeo 3.1 Upscale-Video Polling failedVeo 3.1 Upscale-Video Customer callback: completedVeo 3.1 Upscale-Video Customer callback: failedVeo 3.1 Upscale-Video ErrorsVeo 3.1 Upscale-Video Generated Code SamplesVeo 3.1 Upscale-Video Related GuidesVeo 3.1 Upscale-Video Kling AvatarAPI Reference OverviewKling Avatar EndpointKling Avatar Supported modelsKling Avatar Request schemaKling Avatar Create acceptanceKling Avatar Polling processingKling Avatar Polling completedKling Avatar Polling failedKling Avatar Customer callback: completedKling Avatar Customer callback: failedKling Avatar ErrorsKling Avatar Generated Code SamplesKling Avatar Related GuidesKling Avatar Kling Extend-VideoAPI Reference OverviewKling Extend-Video EndpointKling Extend-Video Supported modelsKling Extend-Video Request schemaKling Extend-Video Create acceptanceKling Extend-Video Polling processingKling Extend-Video Polling completedKling Extend-Video Polling failedKling Extend-Video Customer callback: completedKling Extend-Video Customer callback: failedKling Extend-Video ErrorsKling Extend-Video Generated Code SamplesKling Extend-Video Related GuidesKling Extend-Video Kling Image-to-VideoAPI Reference OverviewKling Image-to-Video EndpointKling Image-to-Video Supported modelsKling Image-to-Video Request schemaKling Image-to-Video Create acceptanceKling Image-to-Video Polling processingKling Image-to-Video Polling completedKling Image-to-Video Polling failedKling Image-to-Video Customer callback: completedKling Image-to-Video Customer callback: failedKling Image-to-Video ErrorsKling Image-to-Video Generated Code SamplesKling Image-to-Video Related GuidesKling Image-to-Video Kling Motion-ControlAPI Reference OverviewKling Motion-Control EndpointKling Motion-Control Supported modelsKling Motion-Control Request schemaKling Motion-Control Create acceptanceKling Motion-Control Polling processingKling Motion-Control Polling completedKling Motion-Control Polling failedKling Motion-Control Customer callback: completedKling Motion-Control Customer callback: failedKling Motion-Control ErrorsKling Motion-Control Generated Code SamplesKling Motion-Control Related GuidesKling Motion-Control Luma Modify-VideoAPI Reference OverviewLuma Modify-Video EndpointLuma Modify-Video Supported modelsLuma Modify-Video Request schemaLuma Modify-Video Create acceptanceLuma Modify-Video Polling processingLuma Modify-Video Polling completedLuma Modify-Video Polling failedLuma Modify-Video Customer callback: completedLuma Modify-Video Customer callback: failedLuma Modify-Video ErrorsLuma Modify-Video Generated Code SamplesLuma Modify-Video Related GuidesLuma Modify-Video InfiniteTalk Audio-to-VideoAPI Reference OverviewInfiniteTalk Audio-to-Video EndpointInfiniteTalk Audio-to-Video Supported modelsInfiniteTalk Audio-to-Video Request schemaInfiniteTalk Audio-to-Video Create acceptanceInfiniteTalk Audio-to-Video Polling processingInfiniteTalk Audio-to-Video Polling completedInfiniteTalk Audio-to-Video Polling failedInfiniteTalk Audio-to-Video Customer callback: completedInfiniteTalk Audio-to-Video Customer callback: failedInfiniteTalk Audio-to-Video ErrorsInfiniteTalk Audio-to-Video Generated Code SamplesInfiniteTalk Audio-to-Video Related GuidesInfiniteTalk Audio-to-Video Hailuo Image-to-VideoAPI Reference OverviewHailuo Image-to-Video EndpointHailuo Image-to-Video Supported modelsHailuo Image-to-Video Request schemaHailuo Image-to-Video Create acceptanceHailuo Image-to-Video Polling processingHailuo Image-to-Video Polling completedHailuo Image-to-Video Polling failedHailuo Image-to-Video Customer callback: completedHailuo Image-to-Video Customer callback: failedHailuo Image-to-Video ErrorsHailuo Image-to-Video Generated Code SamplesHailuo Image-to-Video Related GuidesHailuo Image-to-Video Hailuo Text-to-VideoAPI Reference OverviewHailuo Text-to-Video EndpointHailuo Text-to-Video Supported modelsHailuo Text-to-Video Request schemaHailuo Text-to-Video Create acceptanceHailuo Text-to-Video Polling processingHailuo Text-to-Video Polling completedHailuo Text-to-Video Polling failedHailuo Text-to-Video Customer callback: completedHailuo Text-to-Video Customer callback: failedHailuo Text-to-Video ErrorsHailuo Text-to-Video Generated Code SamplesHailuo Text-to-Video Related GuidesHailuo Text-to-Video Runway Extend-VideoAPI Reference OverviewRunway Extend-Video EndpointRunway Extend-Video Supported modelsRunway Extend-Video Request schemaRunway Extend-Video Create acceptanceRunway Extend-Video Polling processingRunway Extend-Video Polling completedRunway Extend-Video Polling failedRunway Extend-Video Customer callback: completedRunway Extend-Video Customer callback: failedRunway Extend-Video ErrorsRunway Extend-Video Generated Code SamplesRunway Extend-Video Related GuidesRunway Extend-Video Runway Text-to-VideoAPI Reference OverviewRunway Text-to-Video EndpointRunway Text-to-Video Supported modelsRunway Text-to-Video Request schemaRunway Text-to-Video Create acceptanceRunway Text-to-Video Polling processingRunway Text-to-Video Polling completedRunway Text-to-Video Polling failedRunway Text-to-Video Customer callback: completedRunway Text-to-Video Customer callback: failedRunway Text-to-Video ErrorsRunway Text-to-Video Generated Code SamplesRunway Text-to-Video Related GuidesRunway Text-to-Video Runway Aleph Edit-VideoAPI Reference OverviewRunway Aleph Edit-Video EndpointRunway Aleph Edit-Video Supported modelsRunway Aleph Edit-Video Request schemaRunway Aleph Edit-Video Create acceptanceRunway Aleph Edit-Video Polling processingRunway Aleph Edit-Video Polling completedRunway Aleph Edit-Video Polling failedRunway Aleph Edit-Video Customer callback: completedRunway Aleph Edit-Video Customer callback: failedRunway Aleph Edit-Video ErrorsRunway Aleph Edit-Video Generated Code SamplesRunway Aleph Edit-Video Related GuidesRunway Aleph Edit-Video Current AccountAPI Reference ObjectCurrent Account OperationsCurrent Account Current Account objectAPI Reference Object fieldsCurrent Account object Related referenceCurrent Account object Retrieve the current accountAPI Reference EndpointRetrieve the current account Success responseRetrieve the current account Error response (401)Retrieve the current account Error response (403)Retrieve the current account cURL exampleRetrieve the current account Related referenceRetrieve the current account BalanceAPI Reference ObjectBalance OperationsBalance Balance objectAPI Reference Object fieldsBalance object Related referenceBalance object Retrieve the balanceAPI Reference EndpointRetrieve the balance Success responseRetrieve the balance Error response (401)Retrieve the balance Error response (403)Retrieve the balance cURL exampleRetrieve the balance Related referenceRetrieve the balance API KeysAPI Reference ObjectAPI Keys OperationsAPI Keys API Key objectAPI Reference Object fieldsAPI Key object Related referenceAPI Key object List API keysAPI Reference EndpointList API keys RequestList API keys Success responseList API keys Error response (401)List API keys Error response (403)List API keys Error response (403)List API keys Error response (400)List API keys cURL exampleList API keys Related referenceList API keys Retrieve an API keyAPI Reference EndpointRetrieve an API key RequestRetrieve an API key Success responseRetrieve an API key Error response (401)Retrieve an API key Error response (403)Retrieve an API key Error response (403)Retrieve an API key Error response (404)Retrieve an API key cURL exampleRetrieve an API key Related referenceRetrieve an API key Create an API keyAPI Reference EndpointCreate an API key RequestCreate an API key Success responseCreate an API key Error response (401)Create an API key Error response (403)Create an API key Error response (403)Create an API key Error response (400)Create an API key Error response (422)Create an API key cURL exampleCreate an API key Related referenceCreate an API key Update an API keyAPI Reference EndpointUpdate an API key RequestUpdate an API key Success responseUpdate an API key Error response (401)Update an API key Error response (403)Update an API key Error response (403)Update an API key Error response (400)Update an API key Error response (404)Update an API key Error response (422)Update an API key cURL exampleUpdate an API key Related referenceUpdate an API key Delete an API keyAPI Reference EndpointDelete an API key RequestDelete an API key Success responseDelete an API key Error response (401)Delete an API key Error response (403)Delete an API key Error response (403)Delete an API key Error response (404)Delete an API key cURL exampleDelete an API key Related referenceDelete an API key GuardrailsAPI Reference ObjectGuardrails OperationsGuardrails Guardrail objectAPI Reference Object fieldsGuardrail object Related referenceGuardrail object List guardrailsAPI Reference EndpointList guardrails RequestList guardrails Success responseList guardrails Error response (401)List guardrails Error response (403)List guardrails Error response (403)List guardrails Error response (400)List guardrails cURL exampleList guardrails Related referenceList guardrails Retrieve a guardrailAPI Reference EndpointRetrieve a guardrail RequestRetrieve a guardrail Success responseRetrieve a guardrail Error response (401)Retrieve a guardrail Error response (403)Retrieve a guardrail Error response (403)Retrieve a guardrail Error response (404)Retrieve a guardrail cURL exampleRetrieve a guardrail Related referenceRetrieve a guardrail Create a guardrailAPI Reference EndpointCreate a guardrail RequestCreate a guardrail Success responseCreate a guardrail Error response (401)Create a guardrail Error response (403)Create a guardrail Error response (403)Create a guardrail Error response (400)Create a guardrail Error response (422)Create a guardrail cURL exampleCreate a guardrail Related referenceCreate a guardrail Update a guardrailAPI Reference EndpointUpdate a guardrail RequestUpdate a guardrail Success responseUpdate a guardrail Error response (401)Update a guardrail Error response (403)Update a guardrail Error response (403)Update a guardrail Error response (400)Update a guardrail Error response (404)Update a guardrail Error response (422)Update a guardrail cURL exampleUpdate a guardrail Related referenceUpdate a guardrail Delete a guardrailAPI Reference EndpointDelete a guardrail RequestDelete a guardrail Success responseDelete a guardrail Error response (401)Delete a guardrail Error response (403)Delete a guardrail Error response (403)Delete a guardrail Error response (404)Delete a guardrail cURL exampleDelete a guardrail Related referenceDelete a guardrail Guardrail AssignmentsAPI Reference ObjectGuardrail Assignments OperationsGuardrail Assignments Guardrail Assignment objectAPI Reference Object fieldsGuardrail Assignment object Related referenceGuardrail Assignment object List guardrail assignmentsAPI Reference EndpointList guardrail assignments RequestList guardrail assignments Success responseList guardrail assignments Error response (401)List guardrail assignments Error response (403)List guardrail assignments Error response (400)List guardrail assignments cURL exampleList guardrail assignments Related referenceList guardrail assignments Create a guardrail assignmentAPI Reference EndpointCreate a guardrail assignment RequestCreate a guardrail assignment Success responseCreate a guardrail assignment Error response (401)Create a guardrail assignment Error response (403)Create a guardrail assignment Error response (400)Create a guardrail assignment Error response (403)Create a guardrail assignment Error response (404)Create a guardrail assignment Error response (422)Create a guardrail assignment cURL exampleCreate a guardrail assignment Related referenceCreate a guardrail assignment Delete a guardrail assignmentAPI Reference EndpointDelete a guardrail assignment RequestDelete a guardrail assignment Success responseDelete a guardrail assignment Error response (401)Delete a guardrail assignment Error response (403)Delete a guardrail assignment Error response (403)Delete a guardrail assignment Error response (404)Delete a guardrail assignment cURL exampleDelete a guardrail assignment Related referenceDelete a guardrail assignment
API Reference

Guardrail Assignment object

A direct association between one guardrail and exactly one API key or account member.

View Markdown

A direct association between one guardrail and exactly one API key or account member.

03

Object fields

JSON body

Stable fields shared by the resource's reusable object.

Guardrail Assignments5 fields
account_user_idstring | null
Required

Attached account-member prefix ID

api_token_idstring | null
Required

Attached Standard API key prefix ID

created_atstring
Required

Time the assignment was created.

guardrail_idstring
Required

Attached guardrail prefix ID.

idstring
Required

Guardrail assignment prefix ID.

02

Related reference