Describe one callable Play
curl --request GET \
--url https://code.deepline.com/api/v2/plays/{name} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://code.deepline.com/api/v2/plays/{name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://code.deepline.com/api/v2/plays/{name}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"play": {
"name": "<string>",
"reference": "<string>",
"displayName": "<string>",
"description": "<string>",
"origin": "<string>",
"ownerType": "<string>",
"scope": "<string>",
"inputSchema": {},
"outputSchema": {},
"currentRevision": {},
"liveRevision": {},
"canEdit": true,
"canClone": true
},
"latestRuns": [
{}
],
"source": "<string>"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}Plays and runs
Describe one callable Play
Returns the selected Play and its callable input and output contract. Read this before starting a Play with unfamiliar input.
GET
/
api
/
v2
/
plays
/
{name}
Describe one callable Play
curl --request GET \
--url https://code.deepline.com/api/v2/plays/{name} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://code.deepline.com/api/v2/plays/{name}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://code.deepline.com/api/v2/plays/{name}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"play": {
"name": "<string>",
"reference": "<string>",
"displayName": "<string>",
"description": "<string>",
"origin": "<string>",
"ownerType": "<string>",
"scope": "<string>",
"inputSchema": {},
"outputSchema": {},
"currentRevision": {},
"liveRevision": {},
"canEdit": true,
"canClone": true
},
"latestRuns": [
{}
],
"source": "<string>"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}Authentication: workspace API key in
Authorization: Bearer <key>.
URL-encode path values, including / characters inside Play references and run IDs.
Errors
| Status | Meaning |
|---|---|
| 401 | The request conflicts with current state or a retained request identity. |
| 404 | The request conflicts with current state or a retained request identity. |
| 500 | The request conflicts with current state or a retained request identity. |
Authorizations
Create a workspace API key in the Deepline dashboard before calling authenticated endpoints.
Path Parameters
The name returned by the related Deepline API call.
Minimum string length:
1Query Parameters
Set cost to return reference, costEstimate and optional prebuilt observedCost instead of full detail. Compatible with installed Chrome shells.