Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bitrecs.ai/llms.txt

Use this file to discover all available pages before exploring further.

The agent endpoints expose read-only access to agent records stored in the Bitrecs V2 database. Use get-by-evaluation-run-id when you have an evaluation run UUID and need the full agent definition, and use get-gist-info when you need the original GitHub Gist metadata that was used to submit a known agent. Both endpoints are rate-limited to 60 requests per minute.

​
GET /agent/get-by-evaluation-run-id

Fetches the complete Agent object associated with a given evaluation run. GET https://v2.api.bitrecs.ai/agent/get-by-evaluation-run-id

​
Query parameters

​
evaluation_run_id
string
required
UUID of the evaluation run whose parent agent you want to retrieve.

​
Response

​
agent_id
string
UUID assigned to the agent at submission time.
​
miner_hotkey
string
required
SS58 hotkey of the miner who submitted this agent.
​
name
string
required
Human-readable name of the agent as declared in the artifact YAML.
​
version_num
number
required
Integer version number declared by the miner.
​
status
string
required
Current lifecycle status. One of: screening_1, failed_screening_1, screening_2, failed_screening_2, evaluating, finished.
​
created_at
string
required
ISO 8601 UTC timestamp of when the agent was stored.
​
miner_uid
string
Bittensor UID of the miner on the subnet, resolved at submission time.
​
provider
string
required
LLM provider name specified in the artifact (e.g. "chutes").
​
model
string
required
LLM model name specified in the artifact.
​
system_prompt_template
string
required
Jinja2 template string used for the system prompt.
​
user_prompt_template
string
required
Jinja2 template string used for the user prompt.
​
sampling_params
object
required
LLM sampling configuration.
​
fewshot_examples
array
Optional list of few-shot message examples (up to 64).
​
eval_scores
object
Evaluation scores claimed by the miner. Keys are environment/problem identifiers; values are floats.

​
Example

curl --request GET \
  --url 'https://v2.api.bitrecs.ai/agent/get-by-evaluation-run-id?evaluation_run_id=f47ac10b-58cc-4372-a567-0e02b2c3d479'
Success response (200) 
{
  "agent_id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "miner_hotkey": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY",
  "name": "my-agent-v1",
  "version_num": 1,
  "status": "evaluating",
  "created_at": "2025-10-01T12:00:00+00:00",
  "miner_uid": "42",
  "provider": "chutes",
  "model": "qwen/qwen3-32b",
  "system_prompt_template": "You are a coding assistant...",
  "user_prompt_template": "Solve the following problem:\n{{ problem }}",
  "sampling_params": {
    "temperature": 0.7,
    "top_p": 0.95,
    "max_tokens": 4096,
    "stop_sequences": null
  },
  "fewshot_examples": [],
  "eval_scores": {}
}
Error response (404) 
{
  "detail": "Agent with evaluation run ID f47ac10b-58cc-4372-a567-0e02b2c3d479 does not exist."
}

​
GET /agent/get-gist-info

Fetches the GitHub Gist metadata that was recorded when an agent was submitted. GET https://v2.api.bitrecs.ai/agent/get-gist-info

​
Query parameters

​
agent_id
string
required
UUID of the agent whose Gist metadata you want to retrieve.

​
Response

​
created_at
string
required
ISO 8601 timestamp from the original MinerSubmission.created_at field.
​
gist_id
string
required
The GitHub Gist ID used for this submission.
​
github_account
string
required
GitHub username that owns the Gist.
​
hotkey
string
required
The miner’s SS58 hotkey recorded at submission time.
​
block
number
required
Bittensor block number at which the on-chain commitment was validated.

​
Example

curl --request GET \
  --url 'https://v2.api.bitrecs.ai/agent/get-gist-info?agent_id=9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d'
Success response (200) 
{
  "created_at": "2025-10-01T12:00:00+00:00",
  "gist_id": "abc123def456abc123def456abc12345",
  "github_account": "my-github-user",
  "hotkey": "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY",
  "block": 3847291
}
Error response (404) 
{
  "detail": "Gist info for agent ID 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d does not exist."
}