Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ partial void ProcessAgentEditJobResponseContent(
/// Agent edit<br/>
/// Use a background agent to create and edit projects using a natural language prompt.<br/>
/// - **Edit existing project**: Provide a `project_id` to edit an existing project<br/>
/// - **Target a specific composition**: Provide both `project_id` and `composition_id` to direct the agent to a specific composition within the project<br/>
/// - **Create new project**: Provide a `project_name` instead of `project_id` to create a new project<br/>
/// ### Common use cases<br/>
/// - Create new content: "create a 30-second video about cooking tips"<br/>
Expand Down Expand Up @@ -594,6 +595,7 @@ partial void ProcessAgentEditJobResponseContent(
/// Agent edit<br/>
/// Use a background agent to create and edit projects using a natural language prompt.<br/>
/// - **Edit existing project**: Provide a `project_id` to edit an existing project<br/>
/// - **Target a specific composition**: Provide both `project_id` and `composition_id` to direct the agent to a specific composition within the project<br/>
/// - **Create new project**: Provide a `project_name` instead of `project_id` to create a new project<br/>
/// ### Common use cases<br/>
/// - Create new content: "create a 30-second video about cooking tips"<br/>
Expand All @@ -616,8 +618,10 @@ partial void ProcessAgentEditJobResponseContent(
/// Example: My New Project
/// </param>
/// <param name="compositionId">
/// **[Work in progress]** This property is accepted but not yet functional. It will be ignored.<br/>
/// Optional composition ID within the project to edit.<br/>
/// Optional composition ID within the project to target. When provided,<br/>
/// the agent will focus its edits on this specific composition rather<br/>
/// than choosing one automatically. Only valid when `project_id` is also<br/>
/// provided. Requires `project_id`.<br/>
/// Example: 39677a40-1c43-4c36-8449-46cfbc4de2b5
/// </param>
/// <param name="model">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ public partial interface IApiEndpointsClient
/// Agent edit<br/>
/// Use a background agent to create and edit projects using a natural language prompt.<br/>
/// - **Edit existing project**: Provide a `project_id` to edit an existing project<br/>
/// - **Target a specific composition**: Provide both `project_id` and `composition_id` to direct the agent to a specific composition within the project<br/>
/// - **Create new project**: Provide a `project_name` instead of `project_id` to create a new project<br/>
/// ### Common use cases<br/>
/// - Create new content: "create a 30-second video about cooking tips"<br/>
Expand All @@ -34,6 +35,7 @@ public partial interface IApiEndpointsClient
/// Agent edit<br/>
/// Use a background agent to create and edit projects using a natural language prompt.<br/>
/// - **Edit existing project**: Provide a `project_id` to edit an existing project<br/>
/// - **Target a specific composition**: Provide both `project_id` and `composition_id` to direct the agent to a specific composition within the project<br/>
/// - **Create new project**: Provide a `project_name` instead of `project_id` to create a new project<br/>
/// ### Common use cases<br/>
/// - Create new content: "create a 30-second video about cooking tips"<br/>
Expand All @@ -56,8 +58,10 @@ public partial interface IApiEndpointsClient
/// Example: My New Project
/// </param>
/// <param name="compositionId">
/// **[Work in progress]** This property is accepted but not yet functional. It will be ignored.<br/>
/// Optional composition ID within the project to edit.<br/>
/// Optional composition ID within the project to target. When provided,<br/>
/// the agent will focus its edits on this specific composition rather<br/>
/// than choosing one automatically. Only valid when `project_id` is also<br/>
/// provided. Requires `project_id`.<br/>
/// Example: 39677a40-1c43-4c36-8449-46cfbc4de2b5
/// </param>
/// <param name="model">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,10 @@ public sealed partial class AgentEditJobRequest
public string? ProjectName { get; set; }

/// <summary>
/// **[Work in progress]** This property is accepted but not yet functional. It will be ignored.<br/>
/// Optional composition ID within the project to edit.<br/>
/// Optional composition ID within the project to target. When provided,<br/>
/// the agent will focus its edits on this specific composition rather<br/>
/// than choosing one automatically. Only valid when `project_id` is also<br/>
/// provided. Requires `project_id`.<br/>
/// Example: 39677a40-1c43-4c36-8449-46cfbc4de2b5
/// </summary>
/// <example>39677a40-1c43-4c36-8449-46cfbc4de2b5</example>
Expand Down Expand Up @@ -92,8 +94,10 @@ public sealed partial class AgentEditJobRequest
/// Example: My New Project
/// </param>
/// <param name="compositionId">
/// **[Work in progress]** This property is accepted but not yet functional. It will be ignored.<br/>
/// Optional composition ID within the project to edit.<br/>
/// Optional composition ID within the project to target. When provided,<br/>
/// the agent will focus its edits on this specific composition rather<br/>
/// than choosing one automatically. Only valid when `project_id` is also<br/>
/// provided. Requires `project_id`.<br/>
/// Example: 39677a40-1c43-4c36-8449-46cfbc4de2b5
/// </param>
/// <param name="model">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"Order": 1,
"Title": "Agent edit",
"Slug": "agenteditjob",
"Description": "Use a background agent to create and edit projects using a natural language prompt.\n\n- **Edit existing project**: Provide a \u0060project_id\u0060 to edit an existing project\n- **Create new project**: Provide a \u0060project_name\u0060 instead of \u0060project_id\u0060 to create a new project\n\n### Common use cases\n- Create new content: \u0022create a 30-second video about cooking tips\u0022\n- Apply audio effects: \u0022add studio sound to every clip\u0022\n- Remove filler words: \u0022remove all filler words from the transcript\u0022\n- Create highlights: \u0022create a 30-second highlight reel\u0022\n- Content editing: \u0022remove the section from 1:30 to 2:15\u0022\n\n### Async Operations\n\nAgent edits run in the background and return a \u0060job_id\u0060. Monitor progress via the [GET /jobs/{job_id}](#operation/getJob) endpoint.\n\n### Dynamic webhook\n\nIf \u0060callback_url\u0060 is provided, Descript will POST the job status to that URL when the job completes or fails.\nThe payload will match the format returned by [GET /jobs/{job_id}](#operation/getJob).",
"Description": "Use a background agent to create and edit projects using a natural language prompt.\n\n- **Edit existing project**: Provide a \u0060project_id\u0060 to edit an existing project\n- **Target a specific composition**: Provide both \u0060project_id\u0060 and \u0060composition_id\u0060 to direct the agent to a specific composition within the project\n- **Create new project**: Provide a \u0060project_name\u0060 instead of \u0060project_id\u0060 to create a new project\n\n### Common use cases\n- Create new content: \u0022create a 30-second video about cooking tips\u0022\n- Apply audio effects: \u0022add studio sound to every clip\u0022\n- Remove filler words: \u0022remove all filler words from the transcript\u0022\n- Create highlights: \u0022create a 30-second highlight reel\u0022\n- Content editing: \u0022remove the section from 1:30 to 2:15\u0022\n\n### Async Operations\n\nAgent edits run in the background and return a \u0060job_id\u0060. Monitor progress via the [GET /jobs/{job_id}](#operation/getJob) endpoint.\n\n### Dynamic webhook\n\nIf \u0060callback_url\u0060 is provided, Descript will POST the job status to that URL when the job completes or fails.\nThe payload will match the format returned by [GET /jobs/{job_id}](#operation/getJob).",
"Language": "csharp",
"Code": "using var client = new DescriptClient(apiKey);\n\nvar request = global::System.Text.Json.JsonSerializer.Deserialize\u003Cglobal::Descript.AgentEditJobRequest\u003E(\n @\u0022{\n \u0022\u0022project_id\u0022\u0022: \u0022\u00229f36ee32-5a2c-47e7-b1a3-94991d3e3ddb\u0022\u0022,\n \u0022\u0022model\u0022\u0022: \u0022\u0022haiku-4.5\u0022\u0022,\n \u0022\u0022prompt\u0022\u0022: \u0022\u0022add studio sound to every clip\u0022\u0022\n}\u0022)!;\n\nvar response = await client.ApiEndpoints.AgentEditJobAsync(\n request: request\n);",
"Format": "sdk",
Expand Down
8 changes: 5 additions & 3 deletions src/libs/Descript/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,7 @@ paths:
Use a background agent to create and edit projects using a natural language prompt.

- **Edit existing project**: Provide a `project_id` to edit an existing project
- **Target a specific composition**: Provide both `project_id` and `composition_id` to direct the agent to a specific composition within the project
- **Create new project**: Provide a `project_name` instead of `project_id` to create a new project

### Common use cases
Expand Down Expand Up @@ -745,9 +746,10 @@ paths:
type: string
format: uuid
description: |
**[Work in progress]** This property is accepted but not yet functional. It will be ignored.

Optional composition ID within the project to edit.
Optional composition ID within the project to target. When provided,
the agent will focus its edits on this specific composition rather
than choosing one automatically. Only valid when `project_id` is also
provided. Requires `project_id`.
example: 39677a40-1c43-4c36-8449-46cfbc4de2b5
model:
type: string
Expand Down