Batch completions

curl --request POST \
  --url https://api.agentfirst.dev/ai/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompts": [
    "Where can I buy a vintage guitar?",
    "Help me find guitar repair shops nearby.",
    "Do any local stores sell vinyl records?",
    "[Additional prompts here]"
  ],
  "model": "gemini",
  "device": null,
  "country": null,
  "subdivision": null,
  "city": null,
  "language": null,
  "display": null,
  "format": "rendered",
  "expiration": 0,
  "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
'

import requests

url = "https://api.agentfirst.dev/ai/batches"

payload = {
    "prompts": ["Where can I buy a vintage guitar?", "Help me find guitar repair shops nearby.", "Do any local stores sell vinyl records?", "[Additional prompts here]"],
    "model": "gemini",
    "device": None,
    "country": None,
    "subdivision": None,
    "city": None,
    "language": None,
    "display": None,
    "format": "rendered",
    "expiration": 0,
    "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompts: [
      'Where can I buy a vintage guitar?',
      'Help me find guitar repair shops nearby.',
      'Do any local stores sell vinyl records?',
      '[Additional prompts here]'
    ],
    model: 'gemini',
    device: null,
    country: null,
    subdivision: null,
    city: null,
    language: null,
    display: null,
    format: 'rendered',
    expiration: 0,
    callback: 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  })
};

fetch('https://api.agentfirst.dev/ai/batches', 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://api.agentfirst.dev/ai/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompts' => [
        'Where can I buy a vintage guitar?',
        'Help me find guitar repair shops nearby.',
        'Do any local stores sell vinyl records?',
        '[Additional prompts here]'
    ],
    'model' => 'gemini',
    'device' => null,
    'country' => null,
    'subdivision' => null,
    'city' => null,
    'language' => null,
    'display' => null,
    'format' => 'rendered',
    'expiration' => 0,
    'callback' => 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentfirst.dev/ai/batches"

	payload := strings.NewReader("{\n  \"prompts\": [\n    \"Where can I buy a vintage guitar?\",\n    \"Help me find guitar repair shops nearby.\",\n    \"Do any local stores sell vinyl records?\",\n    \"[Additional prompts here]\"\n  ],\n  \"model\": \"gemini\",\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"language\": null,\n  \"display\": null,\n  \"format\": \"rendered\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentfirst.dev/ai/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompts\": [\n    \"Where can I buy a vintage guitar?\",\n    \"Help me find guitar repair shops nearby.\",\n    \"Do any local stores sell vinyl records?\",\n    \"[Additional prompts here]\"\n  ],\n  \"model\": \"gemini\",\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"language\": null,\n  \"display\": null,\n  \"format\": \"rendered\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentfirst.dev/ai/batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompts\": [\n    \"Where can I buy a vintage guitar?\",\n    \"Help me find guitar repair shops nearby.\",\n    \"Do any local stores sell vinyl records?\",\n    \"[Additional prompts here]\"\n  ],\n  \"model\": \"gemini\",\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"language\": null,\n  \"display\": null,\n  \"format\": \"rendered\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "a0482596-c2ad-445a-a435-727002156a20",
  "count": 37
}

"Authorization header must be provided"

"Credit balance is 0; top up at https://agentfirst.dev/#pricing"

"Valid API token must be provided"

"Character counts must be no more than 255"

"Unknown error occurred"

POST

batches

Batch completions

curl --request POST \
  --url https://api.agentfirst.dev/ai/batches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompts": [
    "Where can I buy a vintage guitar?",
    "Help me find guitar repair shops nearby.",
    "Do any local stores sell vinyl records?",
    "[Additional prompts here]"
  ],
  "model": "gemini",
  "device": null,
  "country": null,
  "subdivision": null,
  "city": null,
  "language": null,
  "display": null,
  "format": "rendered",
  "expiration": 0,
  "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
'

import requests

url = "https://api.agentfirst.dev/ai/batches"

payload = {
    "prompts": ["Where can I buy a vintage guitar?", "Help me find guitar repair shops nearby.", "Do any local stores sell vinyl records?", "[Additional prompts here]"],
    "model": "gemini",
    "device": None,
    "country": None,
    "subdivision": None,
    "city": None,
    "language": None,
    "display": None,
    "format": "rendered",
    "expiration": 0,
    "callback": "https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    prompts: [
      'Where can I buy a vintage guitar?',
      'Help me find guitar repair shops nearby.',
      'Do any local stores sell vinyl records?',
      '[Additional prompts here]'
    ],
    model: 'gemini',
    device: null,
    country: null,
    subdivision: null,
    city: null,
    language: null,
    display: null,
    format: 'rendered',
    expiration: 0,
    callback: 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  })
};

fetch('https://api.agentfirst.dev/ai/batches', 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://api.agentfirst.dev/ai/batches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'prompts' => [
        'Where can I buy a vintage guitar?',
        'Help me find guitar repair shops nearby.',
        'Do any local stores sell vinyl records?',
        '[Additional prompts here]'
    ],
    'model' => 'gemini',
    'device' => null,
    'country' => null,
    'subdivision' => null,
    'city' => null,
    'language' => null,
    'display' => null,
    'format' => 'rendered',
    'expiration' => 0,
    'callback' => 'https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.agentfirst.dev/ai/batches"

	payload := strings.NewReader("{\n  \"prompts\": [\n    \"Where can I buy a vintage guitar?\",\n    \"Help me find guitar repair shops nearby.\",\n    \"Do any local stores sell vinyl records?\",\n    \"[Additional prompts here]\"\n  ],\n  \"model\": \"gemini\",\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"language\": null,\n  \"display\": null,\n  \"format\": \"rendered\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.agentfirst.dev/ai/batches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompts\": [\n    \"Where can I buy a vintage guitar?\",\n    \"Help me find guitar repair shops nearby.\",\n    \"Do any local stores sell vinyl records?\",\n    \"[Additional prompts here]\"\n  ],\n  \"model\": \"gemini\",\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"language\": null,\n  \"display\": null,\n  \"format\": \"rendered\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentfirst.dev/ai/batches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompts\": [\n    \"Where can I buy a vintage guitar?\",\n    \"Help me find guitar repair shops nearby.\",\n    \"Do any local stores sell vinyl records?\",\n    \"[Additional prompts here]\"\n  ],\n  \"model\": \"gemini\",\n  \"device\": null,\n  \"country\": null,\n  \"subdivision\": null,\n  \"city\": null,\n  \"language\": null,\n  \"display\": null,\n  \"format\": \"rendered\",\n  \"expiration\": 0,\n  \"callback\": \"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "a0482596-c2ad-445a-a435-727002156a20",
  "count": 37
}

"Authorization header must be provided"

"Credit balance is 0; top up at https://agentfirst.dev/#pricing"

"Valid API token must be provided"

"Character counts must be no more than 255"

"Unknown error occurred"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

prompts

string[]

required

The questions or instructions to use as chat prompts.

Required array length: 1 - 1000 elements

Maximum string length: 2047

Example:

[
  "Where can I buy a vintage guitar?",
  "Help me find guitar repair shops nearby.",
  "Do any local stores sell vinyl records?",
  "[Additional prompts here]"
]

model

enum<string>

default:chatgpt

The AI model to chat with.

Available options:

chatgpt,

gemini,

perplexity,

copilot

Example:

"gemini"

device

string

The name as returned by the devices resource [blocked] of the device to emulate chatting on (these names are case insensitive but must include form- or URL-encoded spaces and punctuation marks); device emulation is unused by default.

Example:

null

country

string

The two-letter ISO code of the country to chat from (these codes are case insensitive); a random country is used by default.

Example:

null

subdivision

string

The alphanumeric second part (proceeding the separator) of a first-level subdivision code in the (prerequisite) country to chat from (these codes are case insensitive); a random subdivision is used by default.

Example:

null

city

string

The commonly spelled name of the city in the (prerequisite) country to chat from (these names are temporarily case sensitive and required to include form- or URL-encoded spaces and punctuation marks); a random city is used by default.

Example:

null

language

string

[Planned] The commonly spelled name or two-letter ISO code of the language to chat in (these names and codes are case insensitive but required to include form- or URL-encoded spaces and punctuation marks); the language is unset by default.

Example:

null

display

string

[Planned] The commonly spelled name or two-letter ISO code of the chat interface’s display language (these names and codes are case insensitive but required to include form- or URL-encoded spaces and punctuation marks); the display language is unset by default or set to the language if given.

Example:

null

format

enum<string>

default:json

The format to output to.

Available options:

json,

rendered,

raw (planned)

Example:

"rendered"

expiration

integer

default:1

The age in days of when to consider a cached completion expired, where 0 disables caching.

Required range: 0 <= x <= 1

Example:

0

callback

string

The HTTP or HTTPS callback URL or Amazon SQS queue URL or ARN to notify when the batch completions have been retrieved; any SQS queue must grant sqs:SendMessage permission to the arn:aws:iam::180363035301:role/api-instance AWS principal.

Maximum string length: 2047

Example:

"https://webhook.site/02e249f8-1faf-4fab-bcf5-78ce683e85a8"

Response

A job identifier and confirmation count.

string<uuid>

required

The identifier to retrieve the batch conversations with.

Example:

"a0482596-c2ad-445a-a435-727002156a20"

count

integer

required

The number of prompts in the batch as confirmed by the API.

Required range: 1 <= x <= 1000

Example:

37

Introduction

Core API

Shared options

API management

For service providers

Batch completions

Authorizations

Body

Response