Skip to main content
POST
/
api
/
public
/
v2
/
folders
/
{folder_id}
/
external-ids
Attach Folder External ID
curl --request POST \
  --url https://api.promptlayer.com/api/public/v2/folders/{folder_id}/external-ids \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "source": "<string>",
  "external_id": "<string>"
}
'
{
  "success": true,
  "external_id": {
    "source": "<string>",
    "external_id": "<string>"
  }
}
Attach a {source, external_id} mapping to an existing folder. Attaching the same mapping to the same folder is idempotent. Reusing the mapping on another entity returns 409 Conflict. See External IDs.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
folder_id
integer
required

Body

application/json

External ID mapping to attach to an entity.

​
source
string
required

The external system or namespace that owns the ID.

Required string length: 1 - 128
​
external_id
string
required

The identifier for this entity in the external system.

Required string length: 1 - 512

Response

External ID attached

​
success
boolean
default:true
required
​
external_id
ExternalId · object
required

Customer-defined mapping between a PromptLayer entity and an external system identifier.