POST /v1/bluejay-as-code

curl --request POST \
  --url https://api.getbluejay.ai/v1/bluejay-as-code

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getbluejay.ai/v1/bluejay-as-code",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$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://api.getbluejay.ai/v1/bluejay-as-code"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getbluejay.ai/v1/bluejay-as-code")

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

request = Net::HTTP::Post.new(url)

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

JSON will be deprecated on November 20th, 2026.

Applies a bundle. Bluejay matches each item by bluejay_as_code_id:

No match: Bluejay creates the item.
Match with changed fields: Bluejay updates the item.
Match with the same fields: no change.

Digital Humans that are not in the bundle are unlinked from the simulation. Custom metrics that are not in the bundle are unlinked from the agent. The response lists each action as text.

If you generate new bluejay_as_code_id values for each push, Bluejay creates duplicate items. Keep the values stable in your config.

Bluejay reads the body as YAML when Content-Type is one of these types:

application/yaml
application/x-yaml
text/yaml
text/x-yaml

Any other Content-Type is read as JSON. Unreadable YAML, or YAML with anchors and aliases (&, *), returns HTTP 400. Use --data-binary, since --data strips the line breaks YAML needs:

curl --request POST \
  --url https://api.getbluejay.ai/v1/bluejay-as-code \
  --header "X-API-Key: $BLUEJAY_API_KEY" \
  --header "Content-Type: application/yaml" \
  --data-binary @simulation.yaml

Headers

Request body

Response

Status codes

Status	Meaning
`200`	Successful Response
`422`	Validation Error

Example request

curl --request POST \
  --url https://api.getbluejay.ai/v1/bluejay-as-code \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "agents": [
      {}
    ],
    "simulations": [
      {}
    ],
    "digital_humans": [
      {}
    ],
    "custom_metrics": [
      {}
    ]
  }'

Example response

200

{
  "valid": true,
  "errors": [
    {
      "entity_type": "<string>",
      "entity_id": null,
      "errors": [
        "<string>"
      ]
    }
  ],
  "actions": [],
  "simulation_id": 123
}

Last modified on October 21, 2026

⌘I

POST /v1/bluejay-as-code

curl --request POST \
  --url https://api.getbluejay.ai/v1/bluejay-as-code

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getbluejay.ai/v1/bluejay-as-code",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$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://api.getbluejay.ai/v1/bluejay-as-code"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.getbluejay.ai/v1/bluejay-as-code")

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

request = Net::HTTP::Post.new(url)

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

​Headers

​Request body

​Response

​Status codes

​Example request

​Example response

Headers

Request body

Response

Status codes

Example request

Example response