{"openapi":"3.0.0","info":{"description":"Language models and AI services API platform","version":[{"name":"v1","value":"v1"}]},"servers":[{"description":"Language models and AI services API platform","url":"https://api.apirails.com/gooseai"}],"paths":{"/v1/engines":{"get":{"tags":["Engines"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.goose.ai/docs/api/engines","api_endpoint":"https://api.goose.ai/v1/engines"},"summary":"List engines","description":"Lists the currently available engines, and provides basic information about each one such as the owner and availability.","security":[{"bearerAuth":[]}]}},"/v1/engines/{engine_id}":{"get":{"tags":["Engines"],"parameters":[{"name":"engine_id","in":"path","description":"Engine Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.goose.ai/docs/api/engines","api_endpoint":"https://api.goose.ai/v1/engines/{engine_id}"},"summary":"Get engines","description":"Gets information about an individual engine available, such as the owner, name, availability, and description.","security":[{"bearerAuth":[]}]}},"/v1/engines/{engine_id}/completions":{"post":{"tags":["Completions"],"parameters":[{"name":"engine_id","in":"path","description":"Engine Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.goose.ai/docs/api/completions","api_endpoint":"https://api.goose.ai/v1/engines/{engine_id}/completions"},"summary":"Create completion","description":"Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"echo":{"type":"boolean","description":"Echo back the prompt in addition to the completion","enum":[true,false]},"frequency_penalty":{"type":"number","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim."},"logit_bias":{"type":"number","description":"Bias for or against the specified tokens appearing"},"logprobs":{"type":"number","description":"Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. "},"max_tokens":{"type":"number","description":"The maximum number of tokens to generate in the completion"},"min_tokens":{"type":"number","description":"The minimum number of tokens to generate in the completion"},"n":{"type":"number","description":"n number of completions to perform per prompt"},"presence_penalty":{"type":"number","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics."},"prompt":{"type":"string","description":"The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays"},"repetition_penalty":{"type":"number","description":"Number between 0 and 8.0. HuggingFace repetition penalty implementation, uses a divisor"},"repetition_penalty_range":{"type":"number","description":"Number between 0 and 2048. The token range to apply the repetition_penalty and repetition_penalty_slope"},"repetition_penalty_slope":{"type":"number","description":"Number between 0 and 1.0"},"stop":{"type":"string","description":"Stops completion when string or one of the strings in the array is encountered."},"stream":{"type":"boolean","description":"Number between 0 and 1.0. Selects tokens according to the expected amount of information they contribute.","enum":[true,false]},"temperature":{"type":"number","description":"Whether to return log probabilities of the output tokens or not"},"tfs":{"type":"number","description":"Number between 0 and 1.0. Similar to nucleus sampling, but it sets its cutoff point based on the cumulative sum of the accelerations (second derivatives) of the sorted token probabilities rather than the probabilities themselves"},"top_a":{"type":"number","description":"Number between 0 and 1.0"},"top_k":{"type":"number","description":"Truncates logits to the set value"},"top_p":{"type":"number","description":"An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability"},"typical_p":{"type":"number","description":"Number between 0 and 1.0. Selects tokens according to the expected amount of information they contribute."}}},"example":{"echo":"","frequency_penalty":"","logit_bias":"","logprobs":"","max_tokens":"","min_tokens":"","n":"","presence_penalty":"","prompt":"","repetition_penalty":"","repetition_penalty_range":"","repetition_penalty_slope":"","stop":"","stream":"","temperature":"","tfs":"","top_a":"","top_k":"","top_p":"","typical_p":""}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}