Skip to content
General Augment Docs

Create Eval

POST
/api/v3/projects/{project_id}/evals
curl --request POST \
  --url https://example.com/api/v3/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/evals \
  --header 'Content-Type: application/json' \
  --data '{ "artifact": {}, "description": "example", "source": "cli" }'

Retain one validated, secret-redacted hosted eval suite.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
project_id
required
Project Id
string format: uuid

Header Parameters

Section titled “Header Parameters”
X-Admin-Key
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
EvalCreateRequestV3
object
artifact
required
Artifact
object
key
additional properties
any
description
Any of:
string
<= 1000 characters
source
Source
string
default: cli >= 1 characters <= 80 characters

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
EvalItemResponseV3
object
artifact
Artifact
object
key
additional properties
any
case_count
required
Case Count
integer
created_at
required
Created At
string format: date-time
description
Any of:
string
failed_count
Failed Count
integer
0
id
required
Id
string format: uuid
kind
required
Kind
string
Allowed values: suite run
name
required
Name
string
passed_count
Passed Count
integer
0
project_id
required
Project Id
string format: uuid
release_fingerprint
Any of:
string
release_generation
Any of:
integer
release_id
Any of:
string format: uuid
schema_version
required
Schema Version
string
source
required
Source
string
status
Any of:
string
suite_id
Any of:
string format: uuid
summary
Summary
object
key
additional properties
any
target
Any of:
string
Allowed values: candidate live
updated_at
required
Updated At
string format: date-time
verdict
Any of:
string
Example
{
  "failed_count": 0,
  "kind": "suite",
  "passed_count": 0,
  "target": "candidate"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}