# Jasper

> Generate content with commands and agent tasks, and manage voices, audiences and projects.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/jasper

## Actions

### Create audience

Create audience in Jasper.

**Inputs**

- Name (`name`, text, required): Name.
- Description (`description`, text, required): Description.
- Access level (`access_level`, text): 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_requirements`, list): Replaces the whole list; send `[]` to clear it.
- Success indicators (`success_indicators`, list): At most 8. Replaces the whole list; send `[]` to clear it.
- Buying triggers (`buying_triggers`, list): Replaces the whole list; send `[]` to clear it.
- Additional characteristics (`additional_characteristics`, list): Replaces the whole list; send `[]` to clear it.
- Core messaging (`core_messaging`, object): Core messaging.
- Content checklist (`content_checklist`, list): Replaces the whole list; send `[]` to clear it.
- Language patterns (`language_patterns`, object): Language patterns.
- Content engagement patterns (`content_engagement_patterns`, object): Content engagement patterns.

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "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_id`, text, required): The ID of the user creating the project
- Name (`name`, text, required): The name of the project
- Access level (`access_level`, text): 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 (`settings`, object): Optional default settings to seed on the project (goal, brand voice, audience, style, knowledge).
- Metadata (`metadata`, object): 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**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "requestId": "example",
    "resource": "example"
  }
}
```

### Create voice

Create voice in Jasper.

**Inputs**

- Name (`name`, text, required): The friendly name of the voice.
- Value (`value`, text, required): The voice's description
- Metadata (`metadata`, object): 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 (`settings`, object): Additional configuration options.

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "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_id`, text, required): Audience ID.

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "deleted": false,
    "requestId": "example",
    "resource": "example"
  }
}
```

### Delete project

Delete project in Jasper.

**Inputs**

- Project ID (`project_id`, text, required): The Project's unique ID

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "deleted": false,
    "requestId": "example",
    "resource": "example"
  }
}
```

### Delete voice

Delete voice in Jasper.

**Inputs**

- Tone (`tone_id`, text, required): The voice's unique ID

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "deleted": false,
    "requestId": "example",
    "resource": "example"
  }
}
```

### Get audience

Get audience in Jasper.

**Inputs**

- Audience (`audience_id`, text, required): Audience ID.

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "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_id`, text, required): The Project's unique ID

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "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_id`, text, required): The external ID (agt_…) or internal UUID of the agent task
- Version (`version`, number): The agent task version to filter by. If not provided, the latest version will be used.

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "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_id`, text, required): The voice's unique ID

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "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 (`page`, number): The desired page number of audiences. Default: `1`.
- Size (`size`, number): The maximum number of audiences to return per page. Defaults to 10 if omitted. At least 1. Default: `10`.

**Outputs**

- `data` (list): The native Jasper response, which can contain per-record response envelopes.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### List projects

List projects in Jasper.

**Inputs**

- Owner (`owner_id`, text): The user Id associated with the workspace
- Name (`name`, text): Filter by the project name
- Limit (`limit`, number): The maximum number of results to return. At most 50. Default: `50`.
- Page (`page`, number): The number of results to skip before starting to collect the results. Default: `1`.
- Sort (`sort`, text): The sorting order for the projects. One 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_start`, date and time): Start date for the created at filter
- Created at end (`created_at_end`, date and time): End date for the created at filter
- Q (`q`, text): 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**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "requestId": "example",
    "resource": "example"
  }
}
```

### List tasks

List tasks in Jasper.

**Inputs**

- Size (`size`, number): Number of agent tasks to return per page. From 1 to 100. Default: `100`.
- Page (`page`, number): Page number (1-indexed). At least 1. Default: `1`.
- Scope (`scope`, text): Filter by agent task scope: PUBLIC or WORKSPACE. One of: `USER`, `WORKSPACE`, `PUBLIC`.
- Include context items (`include_context_items`, true/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_categories`, true/false): Include categories for the agent tasks in the response. Default is false. Default: `false`.
- Search term (`search_term`, text): Search term to filter agent tasks by name, description, categories, or tags. Performs partial case-insensitive matching.

**Outputs**

- `data` (object): Jasper response data.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": {
    "data": [],
    "pagination": {},
    "requestId": "example",
    "resource": "example"
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### List users

List users in Jasper.

**Inputs**

- Limit (`limit`, number): The number of users per page to return in the response
- Page (`page`, number): The desired page number of users

**Outputs**

- `data` (list): The native Jasper response, which can contain per-record response envelopes.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### List voices

List voices in Jasper.

**Inputs**

- Q (`q`, text): 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 (`page`, number): The desired page number of voices. Default: `1`.
- Size (`size`, number): The number of voices per page to return in the response. Default: `10`.

**Outputs**

- `data` (list): The native Jasper response, which can contain per-record response envelopes.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Pass this value to the next page input.
- `records` (list): The records on this page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "records": []
}
```

### Run command

Run command in Jasper.

**Inputs**

- Options (`options`, object): Options for generating a command
- Command (`command`, text, required): Your command for Jasper
- Context (`context`, text): Do you have any background information for Jasper?
- Knowledge IDs (`knowledge_ids`, list): A list of knowledge items to use when generating content. Up to 3 knowledge items are allowed.
- Attachment IDs (`attachment_ids`, list): 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 (`products`, list): 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_id`, text): The style to use when generating a command
- Tone (`tone_id`, text): Tone to use when generating a command
- Audience (`audience_id`, text): The Audience to use when generating a command
- Audience IDs (`audience_ids`, object): 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_on`, text): 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**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "requestId": "example",
    "resource": "example"
  }
}
```

### Run task

Run task in Jasper.

**Inputs**

- Task (`task_id`, text, required): The external ID (agt_…) or internal UUID of the agent task to run
- Context items (`context_items`, list, required): Array of context items - can include both predefined context items (with id and value) and custom context items (with name, question, and answer)
- Version (`version`, number): Agent task version (optional, defaults to latest). A pinned version uses that version's saved agent defaults for omitted IQ fields.
- To language (`to_language`, text): 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_ids`, list): Array of knowledge IDs to use as context to power the agent
- Products (`products`, list): 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_ids`, list): 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_id`, text): Tone ID for the brand voice of the agent's output
- Audience (`audience_id`, text): The audience ID used to customize the agent's output for a target audience.
- Audience IDs (`audience_ids`, object): 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_id`, text): Style Guide ID to apply writing rules to the agent's output
- Visual guideline ID (`visual_guideline_id`, text): 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 (`tools`, list): Array of tools to enable for agent task execution. Can include WEB_SEARCH and/or KNOWLEDGE_SEARCH. One or more of: `WEB_SEARCH` (Web search), `KNOWLEDGE_SEARCH` (Knowledge search).
- Fallback to workspace default iq (`fallback_to_workspace_default_iq`, true/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**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "data": {
      "metadata": {
        "credits": {
          "cost": 1.0
        },
        "translation": {
          "tmsMatches": []
        }
      },
      "output": []
    },
    "requestId": "example",
    "resource": "example"
  }
}
```

### Update audience

Update audience in Jasper.

**Inputs**

- Audience (`audience_id`, text, required): Audience ID.
- Name (`name`, text): Name.
- Description (`description`, text): Description.
- Access level (`access_level`, text): 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_requirements`, list): Replaces the whole list; send `[]` to clear it.
- Success indicators (`success_indicators`, list): At most 8. Replaces the whole list; send `[]` to clear it.
- Buying triggers (`buying_triggers`, list): Replaces the whole list; send `[]` to clear it.
- Additional characteristics (`additional_characteristics`, list): Replaces the whole list; send `[]` to clear it.
- Core messaging (`core_messaging`, object): Core messaging.
- Content checklist (`content_checklist`, list): Replaces the whole list; send `[]` to clear it.
- Language patterns (`language_patterns`, object): Language patterns.
- Content engagement patterns (`content_engagement_patterns`, object): Content engagement patterns.

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "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_id`, text, required): The Project's unique ID
- Owner (`owner_id`, text): The ID of the user updating the project
- Name (`name`, text): The name of the project
- Access level (`access_level`, text): 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 (`settings`, object): Updated default settings for the project (goal, brand voice, audience, style, knowledge). Omit a field to leave it unchanged.
- Metadata (`metadata`, object): 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**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "data": [],
    "requestId": "example",
    "resource": "example"
  }
}
```

### Update voice

Update voice in Jasper.

**Inputs**

- Tone (`tone_id`, text, required): The voice's unique ID
- Name (`name`, text): The friendly name of the voice.
- Value (`value`, text): The voices's description.
- Metadata (`metadata`, object): 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 (`settings`, object): Additional configuration options.

**Outputs**

- `data` (object): Jasper response data.

**Example output**

```json
{
  "data": {
    "data": {
      "appUrl": "example",
      "createdAt": "example",
      "id": "example",
      "metadata": {},
      "name": "example",
      "settings": {
        "appVisibility": "visible"
      },
      "updatedAt": "example",
      "value": "example"
    },
    "requestId": "example",
    "resource": "example"
  }
}
```
