Skip to content
Draft
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 @@ -23,3 +23,9 @@ properties:
anyOf:
- $ref: ../actors/ActorStandby.yaml
- type: "null"
publicConfig:
description: |
Public-facing display configuration of the task's public landing page. The task is not
published by setting it — set `isPublic` via the [Update task](/api/v2/actor-task-put)
endpoint for that. Setting `publicConfig` requires write permission to the task's Actor.
$ref: ./TaskPublicConfig.yaml
11 changes: 11 additions & 0 deletions apify-api/openapi/components/schemas/actor-tasks/Task.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,14 @@ properties:
standbyUrl:
type: [string, "null"]
format: uri
isPublic:
type: boolean
description: |
Whether the task is published on its public landing page. Derived from
`publicConfig.publishedAt`. Set it via the [Update task](/api/v2/actor-task-put)
endpoint to publish or unpublish the task.
examples: [false]
publicConfig:
anyOf:
- $ref: ./TaskPublicConfig.yaml
- type: "null"
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
title: TaskPublicConfig
type: object
description: |
Public-facing configuration of a published task, used by the task's public landing page.
The task's publication state is determined by `publishedAt` - a task is published when
`publishedAt` is set and unpublished when it is `null`.
properties:
publishedAt:
type: [string, "null"]
format: date-time
readOnly: true
description: |
Time when the task was published, or `null` if the task is not published.
This field is server-controlled - to publish or unpublish a task, set `isPublic`
via the [Update task](/api/v2/actor-task-put) endpoint.
examples: ["2025-06-16T09:20:45.777Z"]
seoTitle:
type: [string, "null"]
description: SEO title of the public task page. Defaults to the task title when not set.
examples: [Scrape data from a website]
seoDescription:
type: [string, "null"]
description: SEO description of the public task page. Defaults to the task description when not set.
categorization:
type: [string, "null"]
description: Use-case category of the public task.
inputSchemaFields:
type: [array, "null"]
description: Names of the task input fields displayed on the public task page.
items:
type: string
datasetName:
type: [string, "null"]
description: Name of the dataset from the Actor's dataset schema whose results are displayed.
datasetView:
type: [string, "null"]
description: Key of the dataset view from the Actor's dataset schema used to display results.
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,18 @@ properties:
anyOf:
- $ref: ../actors/ActorStandby.yaml
- type: "null"
publicConfig:
description: |
Public-facing display configuration of the task's public landing page. The provided
fields are merged into the stored configuration and validated. The stored configuration
cannot be cleared this way. Set `isPublic` to change the publication state.
Updating `publicConfig` requires write permission to the task's Actor.
$ref: ./TaskPublicConfig.yaml
isPublic:
type: boolean
description: |
Set to `true` to publish the task on its public landing page, or `false` to unpublish it.
Sending the value the task already has does nothing. Publishing requires the task's
`publicConfig` to be filled in and write permission to the task's Actor; it fails if the
task is not ready to be published, leaving the rest of the update unapplied.
examples: [true]
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ put:

If the object does not define a specific property, its value is not updated.

The `publicConfig` field carries the display configuration of the task's public
landing page, and `isPublic` publishes or unpublishes the task itself. Both require
write permission to the task's Actor.

The response is the full task object as returned by the
[Get task](/api/v2/actor-task-get) endpoint.

Expand Down
Loading