Jasper
App · 20 actions
Generate content with commands and agent tasks, and manage voices, audiences and projects.
Actions
| Action | What it does |
|---|---|
| Create audience | Create audience in Jasper. |
| Create project | Create project in Jasper. |
| Create voice | Create voice in Jasper. |
| Delete audience | Delete audience in Jasper. |
| Delete project | Delete project in Jasper. |
| Delete voice | Delete voice in Jasper. |
| Get audience | Get audience in Jasper. |
| Get project | Get project in Jasper. |
| Get task | Get task in Jasper. |
| Get voice | Get voice in Jasper. |
| List audiences | List audiences in Jasper. |
| List projects | List projects in Jasper. |
| List tasks | List tasks in Jasper. |
| List users | List users in Jasper. |
| List voices | List voices in Jasper. |
| Run command | Run command in Jasper. |
| Run task | Run task in Jasper. |
| Update audience | Update audience in Jasper. |
| Update project | Update project in Jasper. |
| Update voice | Update voice in Jasper. |
Create audience
Create audience in Jasper.
Inputs
- Name
nametextRequired - Name.
- Description
descriptiontextRequired - Description.
- Access level
access_leveltext - Who can access the audience. Defaults to `PRIVATE`, which in Jasper is visible only to workspace admins (and to API keys). Send `PUBLIC` to share it with the whole workspace.One of:
PRIVATE,PUBLIC. Default:PRIVATE. - Use case requirements
use_case_requirementslist - Replaces the whole list; send `[]` to clear it.
- Success indicators
success_indicatorslist - At most 8. Replaces the whole list; send `[]` to clear it.
- Buying triggers
buying_triggerslist - Replaces the whole list; send `[]` to clear it.
- Additional characteristics
additional_characteristicslist - Replaces the whole list; send `[]` to clear it.
- Core messaging
core_messagingobject - Core messaging.
- Content checklist
content_checklistlist - Replaces the whole list; send `[]` to clear it.
- Language patterns
language_patternsobject - Language patterns.
- Content engagement patterns
content_engagement_patternsobject - Content engagement patterns.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"accessLevel": "PRIVATE",
"additionalCharacteristics": [],
"appUrl": "example",
"buyingTriggers": [],
"contentChecklist": [],
"contentEngagementPatterns": {
"attentionHooks": [],
"engagementTriggers": [],
"objectionResponses": [],
"proofPoints": []
},
"contextSources": [],
"coreMessaging": {
"positioningStatement": "example",
"valuePropositions": []
},
"createdAt": "example",
"createdBy": "example",
"description": "example",
"id": "example",
"languagePatterns": {
"donts": [],
"dos": [],
"powerPhrases": [],
"powerWords": [],
"technicalLevel": []
},
"name": "example",
"successIndicators": [],
"updatedAt": "example",
"useCaseRequirements": []
},
"requestId": "example",
"resource": "example"
}
}Create project
Create project in Jasper.
Inputs
- Project owner
owner_idtextRequired - The ID of the user creating the project
- Name
nametextRequired - The name of the project
- Access level
access_leveltext - Who can access the new project. `PRIVATE` (default) restricts access to the owning user; `WORKSPACE` shares the project with all members of the calling workspace.One of:
PRIVATE,WORKSPACE. - Settings
settingsobject - Optional default settings to seed on the project (goal, brand voice, audience, style, knowledge).
- Metadata
metadataobject - An optional set of key-value pairs to attach any data you wish to the project, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long. `null` values are accepted but ignored on create (there is nothing to clear yet) and are supported for symmetry with the update endpoint.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": [],
"requestId": "example",
"resource": "example"
}
}Create voice
Create voice in Jasper.
Inputs
- Name
nametextRequired - The friendly name of the voice.
- Value
valuetextRequired - The voice's description
- Metadata
metadataobject - An optional set of key-value pairs to attach any data you wish to the voice, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long.
- Settings
settingsobject - Additional configuration options.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"appUrl": "example",
"createdAt": "example",
"id": "example",
"metadata": {},
"name": "example",
"settings": {
"appVisibility": "visible"
},
"updatedAt": "example",
"value": "example"
},
"requestId": "example",
"resource": "example"
}
}Delete audience
Delete audience in Jasper.
Inputs
- Audience
audience_idtextRequired - Audience ID.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"deleted": false,
"requestId": "example",
"resource": "example"
}
}Delete project
Delete project in Jasper.
Inputs
- Project ID
project_idtextRequired - The Project's unique ID
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"deleted": false,
"requestId": "example",
"resource": "example"
}
}Delete voice
Delete voice in Jasper.
Inputs
- Tone
tone_idtextRequired - The voice's unique ID
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"deleted": false,
"requestId": "example",
"resource": "example"
}
}Get audience
Get audience in Jasper.
Inputs
- Audience
audience_idtextRequired - Audience ID.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"accessLevel": "PRIVATE",
"additionalCharacteristics": [],
"appUrl": "example",
"buyingTriggers": [],
"contentChecklist": [],
"contentEngagementPatterns": {
"attentionHooks": [],
"engagementTriggers": [],
"objectionResponses": [],
"proofPoints": []
},
"contextSources": [],
"coreMessaging": {
"positioningStatement": "example",
"valuePropositions": []
},
"createdAt": "example",
"createdBy": "example",
"description": "example",
"id": "example",
"languagePatterns": {
"donts": [],
"dos": [],
"powerPhrases": [],
"powerWords": [],
"technicalLevel": []
},
"name": "example",
"successIndicators": [],
"updatedAt": "example",
"useCaseRequirements": []
},
"requestId": "example",
"resource": "example"
}
}Get project
Get project in Jasper.
Inputs
- Project ID
project_idtextRequired - The Project's unique ID
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"accessLevel": "PRIVATE",
"appUrl": "example",
"id": "example",
"metadata": {},
"name": "example",
"settings": {
"audienceId": "example",
"audienceIds": {
"primary": "example",
"secondary": []
},
"goal": "example",
"knowledgeIds": [],
"styleId": "example",
"toneId": "example"
},
"userId": "example"
},
"requestId": "example",
"resource": "example"
}
}Get task
Get task in Jasper.
Inputs
- Task
task_idtextRequired - The external ID (agt_…) or internal UUID of the agent task
- Version
versionnumber - The agent task version to filter by. If not provided, the latest version will be used.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"appUrl": "example",
"categories": [],
"contextItems": [],
"createdAt": "example",
"customFields": {},
"description": "example",
"generationSkillId": {},
"id": "example",
"longDescription": {},
"name": "example",
"publishedAt": {},
"scope": "USER",
"theme": {},
"updatedAt": "example",
"version": 1.0
},
"requestId": "example",
"resource": "example"
}
}Get voice
Get voice in Jasper.
Inputs
- Tone
tone_idtextRequired - The voice's unique ID
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"appUrl": "example",
"createdAt": "example",
"id": "example",
"metadata": {},
"name": "example",
"settings": {
"appVisibility": "visible"
},
"updatedAt": "example",
"value": "example"
},
"requestId": "example",
"resource": "example"
}
}List audiences
List audiences in Jasper.
Inputs
- Page
pagenumber - The desired page number of audiencesDefault:
1. - Size
sizenumber - The maximum number of audiences to return per page. Defaults to 10 if omitted.At least 1. Default:
10.
Outputs
datalist- The native Jasper response, which can contain per-record response envelopes.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null,
"records": []
}List projects
List projects in Jasper.
Inputs
- Owner
owner_idtext - The user Id associated with the workspace
- Name
nametext - Filter by the project name
- Limit
limitnumber - The maximum number of results to returnAt most 50. Default:
50. - Page
pagenumber - The number of results to skip before starting to collect the resultsDefault:
1. - Sort
sorttext - The sorting order for the projectsOne of:
LAST_UPDATED(Last Updated),OLDEST_UPDATED(Oldest Updated),ALPHABETICAL,REVERSE_ALPHABETICAL(Reverse Alphabetical),NEWEST_CREATED(Newest Created),OLDEST_CREATED(Oldest Created). Default:LAST_UPDATED. - Created at start
created_at_startdate and time - Start date for the created at filter
- Created at end
created_at_enddate and time - End date for the created at filter
- Q
qtext - IQ-style search query. Combine up to 10 filters with `AND`. Supported tokens: `userId: ` (equality on the project owner), `metadata[ ]: ` (equality on the project metadata JSONB column). Example: `userId:usr_535B1EC15F5F41EAB1B400E9ED4077B6 AND metadata[source]:crm`. The query is matched in SQL against the projects table ; every recognised token contributes an additive `AND` predicate to the underlying `where` clause.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": [],
"requestId": "example",
"resource": "example"
}
}List tasks
List tasks in Jasper.
Inputs
- Size
sizenumber - Number of agent tasks to return per pageFrom 1 to 100. Default:
100. - Page
pagenumber - Page number (1-indexed)At least 1. Default:
1. - Scope
scopetext - Filter by agent task scope: PUBLIC or WORKSPACEOne of:
USER,WORKSPACE,PUBLIC. - Include context items
include_context_itemstrue/false - Include context items (input fields) in the response for the task to be executed by the agent. Default is false.Default:
false. - Include categories
include_categoriestrue/false - Include categories for the agent tasks in the response. Default is false.Default:
false. - Search term
search_termtext - Search term to filter agent tasks by name, description, categories, or tags. Performs partial case-insensitive matching.
Outputs
dataobject- Jasper response data.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": {
"data": [],
"pagination": {},
"requestId": "example",
"resource": "example"
},
"has_more": false,
"next_cursor": null,
"records": []
}List users
List users in Jasper.
Inputs
- Limit
limitnumber - The number of users per page to return in the response
- Page
pagenumber - The desired page number of users
Outputs
datalist- The native Jasper response, which can contain per-record response envelopes.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null,
"records": []
}List voices
List voices in Jasper.
Inputs
- Q
qtext - You can use the `q` parameter to run a query parameter search. Query parameter search supports the following fields: `name`, `metadata`, and `settings`. Supported operators: `AND` The `AND` operator can be used to combine multiple search criteria. `NOTE`: The `AND` operator supports a maximum of `10` operators Available field examples: `name: value` `metadata[key]:value` `settings[appVisibility]:visible` `metadata[key1]:value1 AND metadata[key2]:value2`
- Page
pagenumber - The desired page number of voicesDefault:
1. - Size
sizenumber - The number of voices per page to return in the responseDefault:
10.
Outputs
datalist- The native Jasper response, which can contain per-record response envelopes.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass this value to the next page input.
recordslist- The records on this page.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null,
"records": []
}Run command
Run command in Jasper.
Inputs
- Options
optionsobject - Options for generating a command
- Command
commandtextRequired - Your command for Jasper
- Context
contexttext - Do you have any background information for Jasper?
- Knowledge IDs
knowledge_idslist - A list of knowledge items to use when generating content. Up to 3 knowledge items are allowed.
- Attachment IDs
attachment_idslist - A list of temporary attachment IDs (prefixed `tmp_`) to use as ad-hoc context when generating content. Create each attachment up front via `POST /v1/attachments` and pass the returned IDs here. Up to 3 attachments are allowed. Temporary attachments are not durable ; use `knowledgeIds` for content that should persist in your workspace.
- Products
productslist - A list of Products to use as context when generating content. Reference each Product by ID, optionally narrowing which of its attributes are included. Discover Products with `GET /v1/products`.
- Style ID
style_idtext - The style to use when generating a command
- Tone
tone_idtext - Tone to use when generating a command
- Audience
audience_idtext - The Audience to use when generating a command
- Audience IDs
audience_idsobject - Structured audience selection with a primary audience and optional secondary audiences. When both `audienceId` and `audienceIds` are sent, `audienceIds` wins.
- Retrieval add on
retrieval_add_ontext - The add-on to use to further enhance your generation with information that lives outside of Jasper. You can further customize the behavior of the add-on with the associated parameter in the options portion of your request body.One of:
webScraper,webSearch.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": [],
"requestId": "example",
"resource": "example"
}
}Run task
Run task in Jasper.
Inputs
- Task
task_idtextRequired - The external ID (agt_…) or internal UUID of the agent task to run
- Context items
context_itemslistRequired - Array of context items - can include both predefined context items (with id and value) and custom context items (with name, question, and answer)
- Version
versionnumber - Agent task version (optional, defaults to latest). A pinned version uses that version's saved agent defaults for omitted IQ fields.
- To language
to_languagetext - Target output language for the completion. Blank values are treated as omitted, allowing the selected task version to apply its saved language.
- Knowledge IDs
knowledge_idslist - Array of knowledge IDs to use as context to power the agent
- Products
productslist - A list of Products to use as context to power the agent. Reference each Product by ID, optionally narrowing which of its attributes are included. Discover Products with `GET /v1/products`.
- Attachment IDs
attachment_idslist - Array of temporary attachment IDs (prefixed `tmp_`) to use as ad-hoc context for this run. Create attachments up front via `POST /v1/attachments` and pass the returned IDs here. Temporary attachments are intended for short-lived context (the same attachment can be referenced across retries of the same run) and are not durable ; use `knowledgeIds` for content that should persist in your workspace.
- Tone
tone_idtext - Tone ID for the brand voice of the agent's output
- Audience
audience_idtext - The audience ID used to customize the agent's output for a target audience.
- Audience IDs
audience_idsobject - Structured audience selection with a primary audience and optional secondary audiences. When both `audienceId` and `audienceIds` are sent, `audienceIds` wins.
- Style guide ID
style_guide_idtext - Style Guide ID to apply writing rules to the agent's output
- Visual guideline ID
visual_guideline_idtext - Visual Guidelines V2 item ID (iqi_…) to use as visual context for this run. The guideline must be active, ready, and accessible in the request workspace. Omitting this field preserves the agent’s saved visual context.
- Tools
toolslist - Array of tools to enable for agent task execution. Can include WEB_SEARCH and/or KNOWLEDGE_SEARCHOne or more of:
WEB_SEARCH(Web search),KNOWLEDGE_SEARCH(Knowledge search). - Fallback to workspace default iq
fallback_to_workspace_default_iqtrue/false - When true, any Jasper IQ your request leaves unspecified falls back to your workspace default for that type (style guide, brand voice, and audience). IQ you pass explicitly always wins, and a type with no workspace default stays unset. Defaults to false, so requests that omit this option behave exactly as before.Default:
false.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"metadata": {
"credits": {
"cost": 1.0
},
"translation": {
"tmsMatches": []
}
},
"output": []
},
"requestId": "example",
"resource": "example"
}
}Update audience
Update audience in Jasper.
Inputs
- Audience
audience_idtextRequired - Audience ID.
- Name
nametext - Name.
- Description
descriptiontext - Description.
- Access level
access_leveltext - Who can access the audience. Defaults to `PRIVATE`, which in Jasper is visible only to workspace admins (and to API keys). Send `PUBLIC` to share it with the whole workspace.One of:
PRIVATE,PUBLIC. Default:PRIVATE. - Use case requirements
use_case_requirementslist - Replaces the whole list; send `[]` to clear it.
- Success indicators
success_indicatorslist - At most 8. Replaces the whole list; send `[]` to clear it.
- Buying triggers
buying_triggerslist - Replaces the whole list; send `[]` to clear it.
- Additional characteristics
additional_characteristicslist - Replaces the whole list; send `[]` to clear it.
- Core messaging
core_messagingobject - Core messaging.
- Content checklist
content_checklistlist - Replaces the whole list; send `[]` to clear it.
- Language patterns
language_patternsobject - Language patterns.
- Content engagement patterns
content_engagement_patternsobject - Content engagement patterns.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"accessLevel": "PRIVATE",
"additionalCharacteristics": [],
"appUrl": "example",
"buyingTriggers": [],
"contentChecklist": [],
"contentEngagementPatterns": {
"attentionHooks": [],
"engagementTriggers": [],
"objectionResponses": [],
"proofPoints": []
},
"contextSources": [],
"coreMessaging": {
"positioningStatement": "example",
"valuePropositions": []
},
"createdAt": "example",
"createdBy": "example",
"description": "example",
"id": "example",
"languagePatterns": {
"donts": [],
"dos": [],
"powerPhrases": [],
"powerWords": [],
"technicalLevel": []
},
"name": "example",
"successIndicators": [],
"updatedAt": "example",
"useCaseRequirements": []
},
"requestId": "example",
"resource": "example"
}
}Update project
Update project in Jasper.
Inputs
- Project ID
project_idtextRequired - The Project's unique ID
- Owner
owner_idtext - The ID of the user updating the project
- Name
nametext - The name of the project
- Access level
access_leveltext - Who can access the project. `PRIVATE` restricts access to the owning user (plus anyone explicitly shared in); `WORKSPACE` shares the project with every member of the calling workspace. Omit to leave the current access level unchanged.One of:
PRIVATE,WORKSPACE. - Settings
settingsobject - Updated default settings for the project (goal, brand voice, audience, style, knowledge). Omit a field to leave it unchanged.
- Metadata
metadataobject - An optional set of key-value pairs to attach any data you wish to the project, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long. Provided string values upsert that key; pass `null` for a key to remove it; omit this field entirely to leave the existing metadata unchanged.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": [],
"requestId": "example",
"resource": "example"
}
}Update voice
Update voice in Jasper.
Inputs
- Tone
tone_idtextRequired - The voice's unique ID
- Name
nametext - The friendly name of the voice.
- Value
valuetext - The voices's description.
- Metadata
metadataobject - An optional set of key-value pairs to attach any data you wish to the voice, in a structured format. You can specify up to 10 keys, with key names up to 40 characters long and values up to 500 characters long.
- Settings
settingsobject - Additional configuration options.
Outputs
dataobject- Jasper response data.
Example output
{
"data": {
"data": {
"appUrl": "example",
"createdAt": "example",
"id": "example",
"metadata": {},
"name": "example",
"settings": {
"appVisibility": "visible"
},
"updatedAt": "example",
"value": "example"
},
"requestId": "example",
"resource": "example"
}
}