# Models

## Gets all models available to the organization.

> Retrieves all models available to the organization, optionally filtered by type and disabled status.

```json
{"openapi":"3.0.4","info":{"title":"Settings Service API","version":"v1"},"servers":[{"url":"https://settings.{region}.jylo.ai","variables":{"tenant":{"default":"example","description":"Tenant name"},"region":{"default":"uk","description":"Region","enum":["uk","us","eu","au","jp"]}}}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Bearer authentication with JWT","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Jylo.Settings.Core.Entities.ModelType":{"enum":[0,1],"type":"integer","format":"int32"},"Jylo.Toolkit.Entities.Models.ModelReadModel":{"required":["contextLength","description","name","objectIdentifier","payoutPercentage"],"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"objectIdentifier":{"type":"string","format":"uuid"},"payoutPercentage":{"type":"integer","format":"int32"},"maxOutputToken":{"type":"integer","format":"int32","nullable":true},"contextLength":{"type":"integer","format":"int32"}},"additionalProperties":false}}},"paths":{"/models":{"get":{"tags":["Models"],"summary":"Gets all models available to the organization.","description":"Retrieves all models available to the organization, optionally filtered by type and disabled status.","parameters":[{"name":"modelType","in":"query","description":"The type of model to filter by.","schema":{"$ref":"#/components/schemas/Jylo.Settings.Core.Entities.ModelType"}},{"name":"includeDisabled","in":"query","description":"Whether to include disabled models.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}}}}},"403":{"description":"Forbidden"}}}}}}
```

## Gets a model by its object identifier if authorized for the organization.

> Retrieves a model by its object identifier if authorized for the organization.

```json
{"openapi":"3.0.4","info":{"title":"Settings Service API","version":"v1"},"servers":[{"url":"https://settings.{region}.jylo.ai","variables":{"tenant":{"default":"example","description":"Tenant name"},"region":{"default":"uk","description":"Region","enum":["uk","us","eu","au","jp"]}}}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Bearer authentication with JWT","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Jylo.Toolkit.Entities.Models.ModelReadModel":{"required":["contextLength","description","name","objectIdentifier","payoutPercentage"],"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"objectIdentifier":{"type":"string","format":"uuid"},"payoutPercentage":{"type":"integer","format":"int32"},"maxOutputToken":{"type":"integer","format":"int32","nullable":true},"contextLength":{"type":"integer","format":"int32"}},"additionalProperties":false}}},"paths":{"/models/{objectIdentifier}":{"get":{"tags":["Models"],"summary":"Gets a model by its object identifier if authorized for the organization.","description":"Retrieves a model by its object identifier if authorized for the organization.","parameters":[{"name":"objectIdentifier","in":"path","description":"The object identifier of the model.","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}}}
```

## Gets models by a list of object identifiers if authorized for the organization.

> Retrieves models by a list of object identifiers if authorized for the organization.

```json
{"openapi":"3.0.4","info":{"title":"Settings Service API","version":"v1"},"servers":[{"url":"https://settings.{region}.jylo.ai","variables":{"tenant":{"default":"example","description":"Tenant name"},"region":{"default":"uk","description":"Region","enum":["uk","us","eu","au","jp"]}}}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Bearer authentication with JWT","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Jylo.Toolkit.Entities.Models.ModelReadModel":{"required":["contextLength","description","name","objectIdentifier","payoutPercentage"],"type":"object","properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"objectIdentifier":{"type":"string","format":"uuid"},"payoutPercentage":{"type":"integer","format":"int32"},"maxOutputToken":{"type":"integer","format":"int32","nullable":true},"contextLength":{"type":"integer","format":"int32"}},"additionalProperties":false}}},"paths":{"/models/get-by-identifiers":{"get":{"tags":["Models"],"summary":"Gets models by a list of object identifiers if authorized for the organization.","description":"Retrieves models by a list of object identifiers if authorized for the organization.","parameters":[{"name":"modelIdentifiers","in":"query","description":"The collection of model object identifiers.","schema":{"type":"array","items":{"type":"string","format":"uuid"}}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Jylo.Toolkit.Entities.Models.ModelReadModel"}}}}},"403":{"description":"Forbidden"}}}}}}
```

## Gets the price for token usage for a specific model if authorized for the organization.

> Retrieves the price for token usage for a specific model if authorized for the organization.

```json
{"openapi":"3.0.4","info":{"title":"Settings Service API","version":"v1"},"servers":[{"url":"https://settings.{region}.jylo.ai","variables":{"tenant":{"default":"example","description":"Tenant name"},"region":{"default":"uk","description":"Region","enum":["uk","us","eu","au","jp"]}}}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Bearer authentication with JWT","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/models/pricing":{"get":{"tags":["Models"],"summary":"Gets the price for token usage for a specific model if authorized for the organization.","description":"Retrieves the price for token usage for a specific model if authorized for the organization.","parameters":[{"name":"modelIdentifier","in":"query","description":"The object identifier of the model.","schema":{"type":"string","format":"uuid"}},{"name":"tokenUsage","in":"query","description":"The number of tokens used.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"type":"number","format":"double"}},"application/json":{"schema":{"type":"number","format":"double"}},"text/json":{"schema":{"type":"number","format":"double"}}}},"403":{"description":"Forbidden"}}}}}}
```