Skip to content
YAC

List example prompts

GET
/v1/yac/examples
curl --request GET \
  --url https://example.com/v1/yac/examples

Example prompts for the chat. A package with its own examplePrompts in the backends config gets those — prompts are about a dataset, and the global list below is written for HuBMAP.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
package
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response 200 Yac Examples
Array<string>

Example generated

[
  "example"
]

404

Section titled “404”

No example prompts for the package, and no global list.

Media typeapplication/json
ErrorResponse

An error body. Authentication failures carry FastAPI’s detail instead of error.

object
error
Any of:
string
code
Any of:
string
errors
Any of:
Array<string>
detail
Any of:
string

Example generated

{
  "error": "example",
  "code": "example",
  "errors": [
    "example"
  ],
  "detail": [
    {}
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}