Skip to main content
PATCH
/
api
/
resources
/
{id}
Update Resource
curl --request PATCH \
  --url https://dash.empirical.run/api/resources/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status": "<string>"
}
'
{
  "data": {
    "resource": {
      "id": 1,
      "project_id": 4,
      "name": "checkout-flow.docx",
      "description": null,
      "status": "uploaded",
      "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "size_bytes": 245000,
      "created_by": "user-id",
      "created_at": "2026-03-20T10:30:00Z",
      "updated_at": "2026-03-20T10:30:01Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.empirical.run/llms.txt

Use this file to discover all available pages before exploring further.

Updates a resource. Use this to:
  • Confirm an upload by setting status to "uploaded" (step 3 of the upload flow)
  • Rename a resource
  • Add a description
{
  "data": {
    "resource": {
      "id": 1,
      "project_id": 4,
      "name": "checkout-flow.docx",
      "description": null,
      "status": "uploaded",
      "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "size_bytes": 245000,
      "created_by": "user-id",
      "created_at": "2026-03-20T10:30:00Z",
      "updated_at": "2026-03-20T10:30:01Z"
    }
  }
}

​
Confirm upload

curl -X PATCH \
  https://dash.empirical.run/api/resources/1 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY" \
  -d '{"status": "uploaded"}'

​
Rename

curl -X PATCH \
  https://dash.empirical.run/api/resources/1 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $EMPIRICALRUN_KEY" \
  -d '{"name": "checkout-flow-v2.docx"}'

Authorizations

​
Authorization
string
header
required

Project API key from the Empirical dashboard.

Path Parameters

​
id
integer
required

File ID.

Required range: -9007199254740991 <= x <= 9007199254740991

Body

application/json

Fields to update.

​
name
string

New name for the resource.

​
description
string

Description for the resource.

​
status
string

Set to "uploaded" to confirm a pending upload.

Allowed value: "uploaded"

Response

Updated resource.

​
data
object
required