mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-11 19:56:03 +00:00
73 lines
7.6 KiB
Text
73 lines
7.6 KiB
Text
---
|
|
id: retrieve-file
|
|
title: "Retrieve file."
|
|
description: "Retrieve file."
|
|
sidebar_label: "Retrieve file."
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWM1uGzcQfpUBT4mxlpwgQRrd1NhpDSSwodiHwjKCETnSMuGSG5IrWxH2GXrvqY/R5+kL9BWK4e7qx5JRB20PAeyLV7uz83E+ft9wyaXwFEpnAwUxWIrnR0f8T1GQXpdROysGYmjhrCQ7PH2rDZ1NPpGMIJ2NqK22M5hqQ6Dt1PkC+Y2eyAQ/Jhs5F5al0TI96X8KnHApgsypQL6Ki5LEQLiUVWSi9K4kH3UznPb2Oi5Er+2sAQhRDASDi0wommJltm5sVnCREzS5gBNlcJNrmYMOgOYGFwHG6b2xEHUmtNoHuJuwqVuRjXqqyXdJJVqYEHiakicrSYG2EHOC4fkpkFWl0zYGBposYlNmi6VtpBn5vWBBfyVw05SIgTPO2iSoMyE9YST1EeMD011afQtRFxQiFiU80RYCSWdVeApT5+EmJ7vCghsM0EIwGt2W2lP4v9Da9IzEvy0W9LAJ4chNjjhDWfnShb0JyFaFGFwJDEGHiDwpmZhglLm43peeK7SKFLQ5t6HqTKBSmuPRnG+oeIomUCY8fam0J8WIK7VrJToZbE3iFscbNKzruc5E1NFwQXe9ucNNEwAc0bkAAyiaartW50ZQYKn2RF1zUS/2dQSmgwuiEJM4tJ2j0QqchwINdwJS/10XCBFj9RCj/HxxcQ5NNEinkgBalv5JPyfeOw8pOAOEkDsfIVRFgX7RTTSlmFXr4KK9RhuThtG2zxNOzfkjavNQ5CaaoY2zM/KQVwXaQ0+ocGIINt7ZGk5qWJblKx9Q5ZOzshHoUxjC5ejddsuqAimIDjxFr2lOUDi/1dkBJ66KCTyUJPVUS3BSVj41ujvj+hZDtDPczdaKvA2VJ5ruIa9bwmDqXdH12h6MXDXLzQKmzhh3E2D09g28+uHoVa9pYliUjTI6fb04Olrj/YgKRo3E1+N5oPJb5zx/vd850miyEXIMEPgiOgcF2kWXmLMCwkzPyQIWrrIxcatTB3g01aOpvidTPX+9xrtwDt6z0ltnhU1r/eIqyHHOHwCSiBdaBvUYCYwudOzBuSEMBNEvAGeoLRiM5LuV6uV9K1UgPycPZCVbiTwpFlZl6bYkGUm15D5a69Fa35W1Xm6uV6esbIsGPjRqX+O39hruSr4jQ/XgrPIQCYu0Kk2ILFiX9jWqs9dqi7Vne3hv4kdTPZrq+zLV0T60B1gouYSlhrPA1aSN1O5GctTRynu63tiOKFbehj0E45reFMuOQI8FRfKMsBTNzjjtDj+mnaRmhBJjvnd7fHq8uWPlOa6YLVZrrkP38ck461mJvqJs16Otsuo61Vd6kulsoA0vKOZOiYGYUfIxD2gg+vNnfVeSRc1XPITQX7Zjr0UmmlW6qazyTHceYzno99EuDnMXIqlDY7DAwxBRfu5JVwjGDyQrr+MivXjcNamra37GrKZhtzP6jt+HD/w+fGjZbTg/hONVHSwc1iEPp6Fv/mwPo+z+sOUD3HTmJlbMMULp3VwrCmMLd/4QAqVP/NXxEKBNnz/ag3S+kbbiwzbuen6KkkKTFD2N+STOOJ98u5t8wlsVQ3PyOOtG9d4pMqE3tmN7cPDnb7//9cevcHxyPjp5M7w4OT44GMA7mqFcJCYaoAIXzbFW4ebNqcG0ipUnaFkKPbhs5VTomW+oWB2CgbNmkSxXuhALTK2/1e+2Je4SvVwvIP/OPK10I93GfmlQWx5NEtqylehVM8+NSHn+n7VnLyyGQWez60ywGjl8uZxgoEtv6ppvf6nIswyvM5EWhQlr7moplA58rVZd794Cn4xa5z2Fb3Ps3uLam2gXXAyain+JTHymxUbbqK/rTOSEinwabfN0KCWVceO9nbWb/bVy+k8nF6Ku/wYZzsO3
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api-deprecated/llama-stack-specification-deprecated-apis
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"Retrieve file."}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/openai/v1/files/{file_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
Retrieve file.
|
|
Returns information about a specific file.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"file_id","in":"path","description":"The ID of the file to use for this request.","required":true,"schema":{"type":"string"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"An OpenAIFileObject containing file information.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"file","default":"file","description":"The object type, which is always \"file\""},"id":{"type":"string","description":"The file identifier, which can be referenced in the API endpoints"},"bytes":{"type":"integer","description":"The size of the file, in bytes"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file was created"},"expires_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the file expires"},"filename":{"type":"string","description":"The name of the file"},"purpose":{"type":"string","enum":["assistants","batch"],"description":"The intended purpose of the file"}},"additionalProperties":false,"required":["object","id","bytes","created_at","expires_at","filename","purpose"],"title":"OpenAIFileObject","description":"OpenAI File object as defined in the OpenAI Files API."}}}},"400":{"description":"The request was invalid or malformed","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":400,"title":"Bad Request","detail":"The request was invalid or malformed"}}}},"429":{"description":"The client has sent too many requests in a given amount of time","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":429,"title":"Too Many Requests","detail":"You have exceeded the rate limit. Please try again later."}}}},"500":{"description":"The server encountered an unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":500,"title":"Internal Server Error","detail":"An unexpected error occurred. Our team has been notified."}}}},"default":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"HTTP status code"},"title":{"type":"string","description":"Error title, a short summary of the error which is invariant for an error type"},"detail":{"type":"string","description":"Error detail, a longer human-readable description of the error"},"instance":{"type":"string","description":"(Optional) A URL which can be used to retrieve more information about the specific occurrence of the error"}},"additionalProperties":false,"required":["status","title","detail"],"title":"Error","description":"Error response from the API. Roughly follows RFC 7807."},"example":{"status":0,"title":"Error","detail":"An unexpected error occurred"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|