Actions50
- Health Actions
- Project Actions
- Score Actions
- Characters Actions
- Environments Actions
- Scenes Actions
- Visuals Actions
- Visual Voiceover Actions
- Visual Image Actions
- Visual Video Actions
- Visual Sound Actions
- Video Actions
Characters → Get Characters
AI-generatedSummary
Retrieve character data from the AdBlast API by specifying the project ID and authentication method.
Inputs
- authenticationMethod (required) — Select between using predefined credentials or dynamically entering an API key.
- url (required) — The base URL for the AdBlast API, required when using dynamic authentication.
- apiKey (required) — Your AdBlast API key, necessary if using dynamic authentication.
- project_id (required) — The ID of the project for which characters will be retrieved.
- requestOptions — Optional settings for the request, including batching and SSL handling.
Output shape
a list of characters
Returns character data associated with the specified project ID. Request options can adjust query behavior.
Examples
Example 1: Get characters for project with ID '01k48af794v8vh2fx2tssj0sag' using predefined credentials
authenticationMethod set to 'credentials', project_id set to '01k48af794v8vh2fx2tssj0sag'.
Example 2: Get characters dynamically using an API key
authenticationMethod set to 'dynamic', project_id set to '01k48af794v8vh2fx2tssj0sag', and url set to 'https://adblast.ai' with an entered API Key.