Get a tool
curl --request GET \
--url https://conigma-tool-server-production.up.railway.app/api/tool/{toolId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "instagram-profiles-collect-by-url",
"name": "<string>",
"description": "<string>",
"availability": {
"status": "available",
"code": "<string>",
"reason": "<string>"
},
"inputSchema": {},
"outputSchema": {},
"connection": {
"required": true,
"configured": true,
"reason": "<string>"
},
"pricing": {
"model": "<string>",
"credits": 123,
"maximumCredits": 123
},
"runtime": {
"version": 123,
"publicEndpoint": "/api/tool/{encodedToolId}",
"idempotencyHeader": "Idempotency-Key"
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}Tool API
Get a tool
The tool’s input schema (JSON Schema), whether this key can run it, whether it needs a connected account, and its price. Reading a tool is free and runs nothing.
GET
/
api
/
tool
/
{toolId}
Get a tool
curl --request GET \
--url https://conigma-tool-server-production.up.railway.app/api/tool/{toolId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://conigma-tool-server-production.up.railway.app/api/tool/{toolId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "instagram-profiles-collect-by-url",
"name": "<string>",
"description": "<string>",
"availability": {
"status": "available",
"code": "<string>",
"reason": "<string>"
},
"inputSchema": {},
"outputSchema": {},
"connection": {
"required": true,
"configured": true,
"reason": "<string>"
},
"pricing": {
"model": "<string>",
"credits": 123,
"maximumCredits": 123
},
"runtime": {
"version": 123,
"publicEndpoint": "/api/tool/{encodedToolId}",
"idempotencyHeader": "Idempotency-Key"
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}{
"status": "completed",
"ok": true,
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"toolId": "<string>",
"result": "<unknown>",
"resultRef": {
"invocationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"error": {
"code": "insufficient_credits",
"message": "<string>",
"retryable": true
},
"billing": {
"chargedCredits": 123,
"items": [
{
"toolId": "<string>",
"summary": "<string>",
"chargedCredits": 123,
"status": "charged",
"externalBilling": "may_apply",
"heldCredits": 123
}
],
"lowBalance": {
"balance": 123,
"message": "<string>",
"nextStep": "<string>",
"url": "<string>"
}
},
"replayed": true,
"chargedThisRequest": 123,
"recovery": {
"toolId": "get-generation",
"input": {
"recoveryId": "<string>"
}
}
}Authorizations
A workspace API key from Settings → Developers → API keys, sent as Authorization: Bearer sk_… (or X-API-Key: sk_…). It acts as one workspace member and uses the workspace's credits.
Path Parameters
The tool's id, exactly as search returns it, URL-encoded once (a / becomes %2F).
Response
The tool.
Example:
"instagram-profiles-collect-by-url"
Show child attributes
Show child attributes
JSON Schema of input.
JSON Schema of result, when the tool declares one.
Whether the tool needs a connected account, and whether this key's member has one.
Show child attributes
Show child attributes
What a run costs in credits. credits is the usual price; maximumCredits the ceiling of a variable one.
Show child attributes
Show child attributes
Show child attributes
Show child attributes