https://developer.mittwald.de/de/assets/js/4d8d9dfe.fe24a76e.js

1"use strict";(self.webpackChunkapi_docs=self.webpackChunkapi_docs||[]).push([[3427],{70817:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>m,contentTitle:()=>c,default:()=>y,frontMatter:()=>d,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"id":"reference/aihosting/ai-hosting-project-get-usage","title":"Get ai hosting plan and usages of a project","description":"Deprecated endpoint. Use /v2/projects/{projectId}/ai-hostings/{planId} instead.","source":"@site/docs/reference/aihosting/ai-hosting-project-get-usage.mdx","sourceDirName":"reference/aihosting","slug":"/reference/aihosting/ai-hosting-project-get-usage","permalink":"/de/docs/v2/reference/aihosting/ai-hosting-project-get-usage","draft":false,"unlisted":false,"editUrl":"https://github.com/mittwald/developer-portal/tree/master/docs/reference/aihosting/ai-hosting-project-get-usage.mdx","tags":[],"version":"current","frontMatter":{"title":"Get ai hosting plan and usages of a project","description":"Deprecated endpoint. Use /v2/projects/{projectId}/ai-hostings/{planId} instead.","openapi":{"method":"get"}},"sidebar":"apiSidebar","previous":{"title":"Get aggregated token usage statistics for an ai hosting plan of a customer","permalink":"/de/docs/v2/reference/aihosting/ai-hosting-plan-get-usage-stats"},"next":{"title":"Get a list of keys of a project","permalink":"/de/docs/v2/reference/aihosting/ai-hosting-project-get-keys"}}');var a=r(74848),n=r(28453),s=r(82390),p=r(45676),o=r(84990);r(20570),r(50776),r(36413),r(21481),r(19365);const d={title:"Get ai hosting plan and usages of a project",description:"Deprecated endpoint. Use /v2/projects/{projectId}/ai-hostings/{planId} instead.",openapi:{method:"get"}},c=void 0,m={},l=[{value:"Request",id:"request",level:2},{value:"Responses",id:"responses",level:2},{value:"Usage examples",id:"usage-examples",level:2}];function g(e){const t={h2:"h2",...(0,n.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(p.X,{path:"/v2/projects/{projectId}/ai-hosting",method:"get",spec:{operationId:"ai-hosting-project-get-usage",deprecated:!0,description:"Deprecated endpoint. Use /v2/projects/{projectId}/ai-hostings/{planId} instead.",parameters:[{in:"path",name:"projectId",required:!0,schema:{type:"string"}},{in:"query",name:"planId",required:!1,schema:{type:"string"}}],responses:{200:{content:{"application/json":{schema:{properties:{description:{type:"string"},keys:{properties:{available:{minimum:-1,type:"integer"},planLimit:{minimum:-1,type:"integer"},used:{minimum:0,type:"integer"}},required:["used","available","planLimit"],type:"object"},modelTermsApprovalRequired:{type:"boolean"},nextTokenReset:{format:"date-time",type:"string"},planId:{type:"string"},projectId:{type:"string"}},required:["keys","projectId","planId","modelTermsApprovalRequired"],type:"object"}}},description:"The project usage and plan.\n"},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}},403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},summary:"Get ai hosting plan and usages of a project.",tags:["AI hosting"]},baseURL:"https://api.mittwald.de/v2",withDescription:!0}

1),"\n",(0,a.jsx)(t.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)(s.Xy,{spec:{operationId:"ai-hosting-project-get-usage",deprecated:!0,description:"Deprecated endpoint. Use /v2/projects/{projectId}/ai-hostings/{planId} instead.",parameters:[{in:"path",name:"projectId",required:!0,schema:{type:"string"}},{in:"query",name:"planId",required:!1,schema:{type:"string"}}],responses:{200:{content:{"application/json":{schema:{properties:{description:{type:"string"},keys:{properties:{available:{minimum:-1,type:"integer"},planLimit:{minimum:-1,type:"integer"},used:{minimum:0,type:"integer"}},required:["used","available","planLimit"],type:"object"},modelTermsApprovalRequired:{type:"boolean"},nextTokenReset:{format:"date-time",type:"string"},planId:{type:"string"},projectId:{type:"string"}},required:["keys","projectId","planId","modelTermsApprovalRequired"],type:"object"}}},description:"The project usage and plan.\n"},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}},403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},summary:"Get ai hosting plan and usages of a project.",tags:["AI hosting"]}}),"\n",(0,a.jsx)(t.h2,{id:"responses",children:"Responses"}),"\n",(0,a.jsx)(s.SL,{spec:{operationId:"ai-hosting-project-get-usage",deprecated:!0,description:"Deprecated endpoint. Use /v2/projects/{projectId}/ai-hostings/{planId} instead.",parameters:[{in:"path",name:"projectId",required:!0,schema:{type:"string"}},{in:"query",name:"planId",required:!1,schema:{type:"string"}}],responses:{200:{content:{"application/json":{schema:{properties:{description:{type:"string"},keys:{properties:{available:{minimum:-1,type:"integer"},planLimit:{minimum:-1,type:"integer"},used:{minimum:0,type:"integer"}},required:["used","available","planLimit"],type:"object"},modelTermsApprovalRequired:{type:"boolean"},nextTokenReset:{format:"date-time",type:"string"},planId:{type:"string"},projectId:{type:"string"}},required:["keys","projectId","planId","modelTermsApprovalRequired"],type:"object"}}},description:"The project usage and plan.\n"},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}}

1,403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},summary:"Get ai hosting plan and usages of a project.",tags:["AI hosting"]}}),"\n",(0,a.jsx)(t.h2,{id:"usage-examples",children:"Usage examples"}),"\n",(0,a.jsx)(o.t,{method:"get",url:"/v2/projects/{projectId}/ai-hosting",spec:{operationId:"ai-hosting-project-get-usage",deprecated:!0,description:"Deprecated endpoint. Use /v2/projects/{projectId}/ai-hostings/{planId} instead.",parameters:[{in:"path",name:"projectId",required:!0,schema:{type:"string"}},{in:"query",name:"planId",required:!1,schema:{type:"string"}}],responses:{200:{content:{"application/json":{schema:{properties:{description:{type:"string"},keys:{properties:{available:{minimum:-1,type:"integer"},planLimit:{minimum:-1,type:"integer"},used:{minimum:0,type:"integer"}},required:["used","available","planLimit"],type:"object"},modelTermsApprovalRequired:{type:"boolean"},nextTokenReset:{format:"date-time",type:"string"},planId:{type:"string"},projectId:{type:"string"}},required:["keys","projectId","planId","modelTermsApprovalRequired"],type:"object"}}},description:"The project usage and plan.\n"},400:{description:"Validation Error caused by invalid input data in the request",content:{"application/json":{schema:{type:"object",required:["type","validationErrors"],properties:{type:{type:"string",enum:["ValidationError"]},message:{type:"string",example:"Validation failed"},validationErrors:{type:"array",items:{type:"object",required:["message","path","type"],properties:{message:{type:"string",description:"The standard error message",example:"should be string"},path:{type:"string",description:'The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.\n',example:".address.street"},type:{type:"string",description:'ajv validation error type (e.g. "format", "required", "type") or own validation error types',example:"format"},context:{type:"object",example:{format:"email"},description:'The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. "missingProperty" for type "required")\n',additionalProperties:{type:"string"}}}}}}}}}},403:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},404:{description:"The requested resource was not found",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}},429:{description:"Your request ran into a rate limit. You have to wait until rate limit expires\n",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string",example:"too many requests"},type:{type:"string",example:"RateLimitError"}}}}}},default:{description:"An unexpected Error that occurred while handling the request",content:{"application/json":{schema:{type:"object",required:["type","message"],properties:{message:{type:"string",example:"Something went wrong"},type:{type:"string",example:"InternalServerError"}}}}}}},summary:"Get ai hosting plan and usages of a project.",tags:["AI hosting"]},baseURL:"https://api.mittwald.de/v2",withJavascript:!0,withPHP:!0})]})}function y(e={}){const{wrapper:t}={...(0,n.R)(),...e.components};return t?(0,a.jsx)(t,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]);