Skip to content

Commit 07330d4

Browse files
kristinaorekhovagitbook-bot
authored andcommitted
GITBOOK-1166: Model Catalogue API: remove stray blockquote marker before endpoint schema
1 parent 72f0e9b commit 07330d4

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

docs/api-references/service-endpoints/models-catalogue.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,15 @@ Unknown values are ignored rather than rejected, so a typo returns a valid respo
3232

3333
Every filter below narrows _which models_ come back. Filters are independent of `include`, so you can filter on capabilities without asking for the capabilities section.
3434

35-
<table data-search="false"><thead><tr><th>Parameter</th><th>Keeps models that…</th></tr></thead><tbody><tr><td><code>id</code></td><td>match this id <strong>or carry it as an alias</strong></td></tr><tr><td><code>type</code></td><td>are served through this endpoint type</td></tr><tr><td><code>tags</code></td><td>carry this tag, e.g. <code>playground:video</code></td></tr><tr><td><code>modalities</code></td><td>have it among input <strong>or</strong> output modalities</td></tr><tr><td><code>input_modalities</code></td><td>accept this input modality</td></tr><tr><td><code>output_modalities</code></td><td>produce this output modality</td></tr><tr><td><code>capabilities</code></td><td>declare this capability</td></tr></tbody></table>
35+
| Parameter | Keeps models that… |
36+
| ------------------- | -------------------------------------------- |
37+
| `id` | match this id **or carry it as an alias** |
38+
| `type` | are served through this endpoint type |
39+
| `tags` | carry this tag, e.g. `playground:video` |
40+
| `modalities` | have it among input **or** output modalities |
41+
| `input_modalities` | accept this input modality |
42+
| `output_modalities` | produce this output modality |
43+
| `capabilities` | declare this capability |
3644

3745
* **Several values, one parameter — OR.** `?capabilities=text_to_video,image_to_video` returns models that do either.
3846
* **Several parameters — AND.** `?output_modalities=video&capabilities=audio_generation` returns models that do both.
@@ -53,8 +61,6 @@ Returns the full list of models matching the given filters, with the requested o
5361

5462
## GET /v1/models
5563

56-
>
57-
5864
```json
5965
{"openapi":"3.0.0","info":{"title":"AIML API","version":"1.0.0"},"servers":[{"url":"https://api.aimlapi.com"}],"paths":{"/v1/models":{"get":{"operationId":"ModelsController_getModelsV2","parameters":[{"name":"id","in":"query","required":false,"description":"Keep models matching this id, or carrying it as an alias. Comma-separated or repeated values are OR'd together.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Keep models served through this endpoint type.","schema":{"type":"string"}},{"name":"tags","in":"query","required":false,"description":"Keep models carrying this tag, e.g. playground:video. Comma-separated or repeated values are OR'd together.","schema":{"type":"string"}},{"name":"modalities","in":"query","required":false,"description":"Keep models with this modality among either their input or output modalities.","schema":{"type":"string"}},{"name":"input_modalities","in":"query","required":false,"description":"Keep models accepting this input modality.","schema":{"type":"string"}},{"name":"output_modalities","in":"query","required":false,"description":"Keep models producing this output modality.","schema":{"type":"string"}},{"name":"capabilities","in":"query","required":false,"description":"Keep models declaring this capability, e.g. image_to_video. Comma-separated or repeated values are OR'd together; combining with other filter parameters is AND'd.","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"description":"Attach optional sections to each model: pricing, modalities, capabilities, or all (?details=true is a synonym for all). Comma-separated. Unknown values are ignored rather than rejected.","schema":{"type":"string"}}],"responses":{"200":{"description":"The live model catalogue, filtered and expanded as requested. Responses carry an ETag; see Caching below.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","description":"Always \"list\"."},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Canonical unique identifier of the model."},"aliases":{"type":"array","nullable":true,"description":"Other names this model can still be requested under.","items":{"type":"string"}},"type":{"type":"string","description":"Endpoint type this model is served through."},"info":{"type":"object","description":"Model identity.","properties":{"name":{"type":"string","description":"Human-readable model name."},"developer":{"type":"string","description":"Organization or company that developed the model."}},"required":["name","developer"]},"tags":{"type":"array","description":"Free-form tags, e.g. playground:tts.","items":{"type":"string"}},"pricing":{"type":"object","nullable":true,"description":"Present only with ?include=pricing or all. See Reading prices below."},"modalities":{"type":"object","nullable":true,"description":"Present only with ?include=modalities or all. Input and output modalities the model handles."},"capabilities":{"type":"array","nullable":true,"description":"Present only with ?include=capabilities or all. Declared capabilities, e.g. image_to_video.","items":{"type":"string"}}},"required":["id","type","info","tags"]}}},"required":["object","data"]}}}}}}}}}}
6066
```

0 commit comments

Comments
 (0)