Skip to content

Asana: Create a project brief

Asana projectBriefs.createProjectBrief: arguments, response, policy and SDK examples.

← Project briefs operations · Get started

Operation asana.createprojectbrief

Provider route: POST /projects/{project_gid}/project_briefs. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/asana with npm, or alter-sdk-asana with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AsanaIntegration } from "@alter-ai/asana";
async function execute(input: Parameters<AsanaIntegration["projectBriefs"]["createProjectBrief"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new AsanaIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.projectBriefs.createProjectBrief(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_asana import AsanaIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = AsanaIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.project_briefs.create_project_brief(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.project_gidstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.opt_prettybooleanOptional
query.opt_fieldsarrayOptional
query.opt_fields[]stringEach itemOne of: html_text, permalink_url, project, project.name, project.resource_subtype, text, title
bodyobjectRequired within parent
body.dataModelOptionalExpand Create a project brief — request body — body data

Referenced models: Create a project brief — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)objectAll variants apply
$ (allOf 1).dataModelOptionalExpand Get a project brief — response body — data data — Project Brief Response
$ (allOf 2)ModelAll variants applyExpand Get a project brief — response body — data

Referenced models: Get a project brief — response body — data data — Project Brief Response, Get a project brief — response body — data

Get a project brief — response body — data data — Project Brief Response
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project brief — response body — data data gid, html text, resource type, title
$ (allOf 2)objectAll variants apply
$ (allOf 2).textstringOptional[Opt In](/docs/inputoutput-options). The plain text of the project brief.
$ (allOf 2).permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
$ (allOf 2).projectJSONOptional
$ (allOf 2).project (allOf 1)ModelAll variants applyExpand Search projects in a workspace — response body — data data item
$ (allOf 2).project (allOf 2)objectAll variants applyThe project with which this project brief is associated.

Referenced models: Get a project brief — response body — data data gid, html text, resource type, title, Search projects in a workspace — response body — data data item

Get a project brief — response body — data
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get a project brief — response body — data data — sdk__Project Brief Response

Referenced models: Get a project brief — response body — data data — sdk__Project Brief Response

Create a project brief — request body — body data
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project brief — response body — data data gid, html text, resource type, title
$ (allOf 2)objectAll variants apply
$ (allOf 2).textstringOptionalThe plain text of the project brief. When writing to a project brief, you can specify either `html_text` (preferred) or `text`, but not both.

Referenced models: Get a project brief — response body — data data gid, html text, resource type, title

Get a project brief — response body — data data gid, html text, resource type, title
FieldTypePresenceDescription and constraints
$JSONRoot
$ (allOf 1)ModelAll variants applyExpand Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
$ (allOf 2)objectAll variants apply
$ (allOf 2).titlestringOptionalThe title of the project brief.
$ (allOf 2).html_textstringOptionalHTML formatted text for the project brief. See [rich text](/docs/rich-text).

Referenced models: Get a project brief — response body — data data gid, html text, resource type, title gid, resource type

Search projects in a workspace — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootA *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: default_project, custom
Get a project brief — response body — data data — sdk__Project Brief Response
FieldTypePresenceDescription and constraints
$objectRootA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *Project Brief* allows you to explain the what and why of the project to your team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true
titlestringOptionalThe title of the project brief.
html_textstringOptionalHTML formatted text for the project brief. See [rich text](/docs/rich-text).
textstringOptional[Opt In](/docs/inputoutput-options). The plain text of the project brief.
permalink_urlstringOptionalA url that points directly to the object within Asana.
Read only: true
projectobjectOptionalA generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.A generic Asana Resource, containing a globally unique identifier.A generic Asana Resource, containing a globally unique identifier.
A *project* represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards. It exists in a single workspace or organization and is accessible to a subset of users in that workspace or organization, depending on its permissions.
The project with which this project brief is associated.
project.gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
project.resource_typestringOptionalThe base type of this resource.
Read only: true
project.namestringOptionalName of the project. This is generally a short sentence fragment that fits on a line in the UI for maximum readability. However, it can be longer.
project.resource_subtypestringOptionalThe subtype of this resource. Different subtypes retain many of the same fields and behavior, but may render differently in Asana or represent resources with different semantic meaning.
Known values: default_project, custom
Get a project brief — response body — data data gid, html text, resource type, title gid, resource type
FieldTypePresenceDescription and constraints
$objectRootA *Project Brief* allows you to explain the what and why of the project to your team.
gidstringOptionalGlobally unique identifier of the resource, as a string.
Read only: true
resource_typestringOptionalThe base type of this resource.
Read only: true

SDK function policy ID: asana.createprojectbrief. Catalog operation: asana:createProjectBrief. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.