API Reference

Workers

Scripts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Tail

List Tails

client.workers.scripts.tail.get(stringscriptName, TailGetParams { account_id } params?, RequestOptionsoptions?): TailGetResponse { id, expires_at, url }

GET/accounts/{account_id}/workers/scripts/{script_name}/tails

Start Tail

client.workers.scripts.tail.create(stringscriptName, TailCreateParams { account_id, body } params, RequestOptionsoptions?): TailCreateResponse { id, expires_at, url }

POST/accounts/{account_id}/workers/scripts/{script_name}/tails

Delete Tail

client.workers.scripts.tail.delete(stringscriptName, stringid, TailDeleteParams { account_id } params?, RequestOptionsoptions?): TailDeleteResponse { errors, messages, success }

DELETE/accounts/{account_id}/workers/scripts/{script_name}/tails/{id}

ModelsExpand Collapse

ConsumerScript { service, environment, namespace }

A reference to a script that will consume logs from the attached Worker.

service: string

Name of Worker that is to be the consumer.

environment?: string

Optional environment if the Worker utilizes one.

namespace?: string

Optional dispatch namespace the script belongs to.

TailGetResponse { id, expires_at, url }

id: string

Identifier.

maxLength32

expires_at: string

url: string

TailCreateResponse { id, expires_at, url }

id: string

Identifier.

maxLength32

expires_at: string

url: string

TailDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.