Skip to main content
POST
Create a Skill from a task
Recording usually takes a few minutes. Poll GET /v1/skill-creations/{creation_id} until status is ready or failed. See Create a skill from a task for a full example.

Authorizations

Authorization
string
header
required

API key with the vd_sk_ prefix. Create keys from Settings, API Keys in the dashboard.

Headers

Idempotency-Key
string

Retry-safe key. The same key from the same account returns what it already started.

Body

application/json
task
string
required

What the skill does, in plain words.

Required string length: 3 - 2000
Example:

"Search for dentists in Austin and list them"

start_url
string
required

The http(s) page the skill starts on.

Maximum string length: 2000
Example:

"https://www.google.com/maps"

name
string

Skill name. Derived from the task when omitted.

Maximum string length: 100
inputs
object

Up to 5 inputs, each mapped to the example value the recording uses. Each value must appear in what the browser types or opens. Inferred when omitted.

Example:
output_fields

Up to 25 columns, as {name: description} or a list of names. Inferred when omitted.

Example:
visibility
enum<string>
default:private
Available options:
private,
public

Response

Creation started (or the existing one, for a repeated Idempotency-Key).

creation_id
string
Example:

"sc_3f9a1c2b7d4e5f60"

status
enum<string>
Available options:
queued,
recording,
validating,
ready,
failed
status_url
string
Example:

"/v1/skill-creations/sc_3f9a1c2b7d4e5f60"

skill_id
string | null

Set once the recording is saved.

slug
string | null

Set once the recording is saved.

skill_url
string | null

/v1/skills/{slug} once saved.

run_url
string | null

/v1/skills/{slug}/run once ready.

error
string | null

Why it failed.

inputs
object | null
output_fields
object | null
credits_charged
integer
created_at
string<date-time> | null
updated_at
string<date-time> | null
idempotent_replay
boolean

True when an Idempotency-Key matched an existing creation.

diagnosis
object | null

On failure: what was tried and example hints.