# Models ## The TopLevelMeta object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"TopLevelMeta":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Server timestamp in milliseconds"},"authentication":{"type":"string","description":"Authentication method, e.g. apiKey"},"links":{"type":"object","properties":{"me":{"type":"string","format":"uri"}}}}}}}} ``` ## The PaginationLinks object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"PaginationLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"first":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}}} ``` ## The LinkObject object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The Link object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The JsonApiLinkage object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The AssetAttributes object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetAttributes":{"type":"object","description":"Asset attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"tags":{"type":"array","items":{"type":"string"}},"versions":{"type":"object","additionalProperties":true},"collectionIds":{"type":"array","items":{"type":"string"}},"collections":{"type":"array","items":{"type":"object"}},"skus":{"type":"array","items":{"type":"string"}},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"views":{"type":"integer"},"downloads":{"type":"integer"},"clientId":{"type":"string"},"createdBy":{"type":"string"},"sensitiveAt":{"type":"integer"},"expires":{"type":"integer"},"licenseExpiresAt":{"type":"integer"},"batchId":{"type":"string"},"favs":{"type":"array","items":{"type":"string"}},"approvedAt":{"type":"integer"},"taskIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":true}}}} ``` ## The AssetResource object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetResource":{"type":"object","properties":{"type":{"type":"string","enum":["assets"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/AssetAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"AssetAttributes":{"type":"object","description":"Asset attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"tags":{"type":"array","items":{"type":"string"}},"versions":{"type":"object","additionalProperties":true},"collectionIds":{"type":"array","items":{"type":"string"}},"collections":{"type":"array","items":{"type":"object"}},"skus":{"type":"array","items":{"type":"string"}},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"views":{"type":"integer"},"downloads":{"type":"integer"},"clientId":{"type":"string"},"createdBy":{"type":"string"},"sensitiveAt":{"type":"integer"},"expires":{"type":"integer"},"licenseExpiresAt":{"type":"integer"},"batchId":{"type":"string"},"favs":{"type":"array","items":{"type":"string"}},"approvedAt":{"type":"integer"},"taskIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The UserAttributes object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"UserAttributes":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"profilePicture":{"type":"string","nullable":true},"jobTitle":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true}},"additionalProperties":false}}}} ``` ## The UserResource object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"UserResource":{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/UserAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"UserAttributes":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"profilePicture":{"type":"string","nullable":true},"jobTitle":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true}},"additionalProperties":false},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The AssetVersionSummary object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetVersionSummary":{"type":"object","properties":{"size":{"type":"integer"},"type":{"type":"string"},"extension":{"type":"string"}},"additionalProperties":false}}}} ``` ## The AssetVersionsSummaryMap object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetVersionsSummaryMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetVersionSummary"}},"AssetVersionSummary":{"type":"object","properties":{"size":{"type":"integer"},"type":{"type":"string"},"extension":{"type":"string"}},"additionalProperties":false}}}} ``` ## The AssetListAssetAttributes object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetListAssetAttributes":{"allOf":[{"$ref":"#/components/schemas/AssetAttributes"},{"type":"object","properties":{"versions":{"$ref":"#/components/schemas/AssetVersionsSummaryMap"}}}]},"AssetAttributes":{"type":"object","description":"Asset attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"tags":{"type":"array","items":{"type":"string"}},"versions":{"type":"object","additionalProperties":true},"collectionIds":{"type":"array","items":{"type":"string"}},"collections":{"type":"array","items":{"type":"object"}},"skus":{"type":"array","items":{"type":"string"}},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"views":{"type":"integer"},"downloads":{"type":"integer"},"clientId":{"type":"string"},"createdBy":{"type":"string"},"sensitiveAt":{"type":"integer"},"expires":{"type":"integer"},"licenseExpiresAt":{"type":"integer"},"batchId":{"type":"string"},"favs":{"type":"array","items":{"type":"string"}},"approvedAt":{"type":"integer"},"taskIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"AssetVersionsSummaryMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetVersionSummary"}},"AssetVersionSummary":{"type":"object","properties":{"size":{"type":"integer"},"type":{"type":"string"},"extension":{"type":"string"}},"additionalProperties":false}}}} ``` ## The AssetListAssetResource object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetListAssetResource":{"type":"object","properties":{"type":{"type":"string","enum":["assets"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/AssetListAssetAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"AssetListAssetAttributes":{"allOf":[{"$ref":"#/components/schemas/AssetAttributes"},{"type":"object","properties":{"versions":{"$ref":"#/components/schemas/AssetVersionsSummaryMap"}}}]},"AssetAttributes":{"type":"object","description":"Asset attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"tags":{"type":"array","items":{"type":"string"}},"versions":{"type":"object","additionalProperties":true},"collectionIds":{"type":"array","items":{"type":"string"}},"collections":{"type":"array","items":{"type":"object"}},"skus":{"type":"array","items":{"type":"string"}},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"views":{"type":"integer"},"downloads":{"type":"integer"},"clientId":{"type":"string"},"createdBy":{"type":"string"},"sensitiveAt":{"type":"integer"},"expires":{"type":"integer"},"licenseExpiresAt":{"type":"integer"},"batchId":{"type":"string"},"favs":{"type":"array","items":{"type":"string"}},"approvedAt":{"type":"integer"},"taskIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"AssetVersionsSummaryMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetVersionSummary"}},"AssetVersionSummary":{"type":"object","properties":{"size":{"type":"integer"},"type":{"type":"string"},"extension":{"type":"string"}},"additionalProperties":false},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The AssetListResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetListResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TopLevelMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AssetListAssetResource"}}},"required":["meta","data"]},"TopLevelMeta":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Server timestamp in milliseconds"},"authentication":{"type":"string","description":"Authentication method, e.g. apiKey"},"links":{"type":"object","properties":{"me":{"type":"string","format":"uri"}}}}},"PaginationLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"first":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}},"AssetListAssetResource":{"type":"object","properties":{"type":{"type":"string","enum":["assets"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/AssetListAssetAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"AssetListAssetAttributes":{"allOf":[{"$ref":"#/components/schemas/AssetAttributes"},{"type":"object","properties":{"versions":{"$ref":"#/components/schemas/AssetVersionsSummaryMap"}}}]},"AssetAttributes":{"type":"object","description":"Asset attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"tags":{"type":"array","items":{"type":"string"}},"versions":{"type":"object","additionalProperties":true},"collectionIds":{"type":"array","items":{"type":"string"}},"collections":{"type":"array","items":{"type":"object"}},"skus":{"type":"array","items":{"type":"string"}},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"views":{"type":"integer"},"downloads":{"type":"integer"},"clientId":{"type":"string"},"createdBy":{"type":"string"},"sensitiveAt":{"type":"integer"},"expires":{"type":"integer"},"licenseExpiresAt":{"type":"integer"},"batchId":{"type":"string"},"favs":{"type":"array","items":{"type":"string"}},"approvedAt":{"type":"integer"},"taskIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":true},"AssetVersionsSummaryMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AssetVersionSummary"}},"AssetVersionSummary":{"type":"object","properties":{"size":{"type":"integer"},"type":{"type":"string"},"extension":{"type":"string"}},"additionalProperties":false},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The AssetResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"AssetResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TopLevelMeta"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"},"data":{"$ref":"#/components/schemas/AssetResource"}},"required":["meta","data"]},"TopLevelMeta":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Server timestamp in milliseconds"},"authentication":{"type":"string","description":"Authentication method, e.g. apiKey"},"links":{"type":"object","properties":{"me":{"type":"string","format":"uri"}}}}},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]},"AssetResource":{"type":"object","properties":{"type":{"type":"string","enum":["assets"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/AssetAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"AssetAttributes":{"type":"object","description":"Asset attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"tags":{"type":"array","items":{"type":"string"}},"versions":{"type":"object","additionalProperties":true},"collectionIds":{"type":"array","items":{"type":"string"}},"collections":{"type":"array","items":{"type":"object"}},"skus":{"type":"array","items":{"type":"string"}},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"views":{"type":"integer"},"downloads":{"type":"integer"},"clientId":{"type":"string"},"createdBy":{"type":"string"},"sensitiveAt":{"type":"integer"},"expires":{"type":"integer"},"licenseExpiresAt":{"type":"integer"},"batchId":{"type":"string"},"favs":{"type":"array","items":{"type":"string"}},"approvedAt":{"type":"integer"},"taskIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":true}}}} ``` ## The UserResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"UserResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TopLevelMeta"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"},"data":{"$ref":"#/components/schemas/UserResource"}},"required":["meta","data"]},"TopLevelMeta":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Server timestamp in milliseconds"},"authentication":{"type":"string","description":"Authentication method, e.g. apiKey"},"links":{"type":"object","properties":{"me":{"type":"string","format":"uri"}}}}},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]},"UserResource":{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/UserAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"UserAttributes":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"profilePicture":{"type":"string","nullable":true},"jobTitle":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true}},"additionalProperties":false}}}} ``` ## The UserListResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"UserListResponse":{"type":"object","properties":{"meta":{"type":"object"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserResource"}}},"required":["meta","data"]},"PaginationLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"first":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}},"UserResource":{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/UserAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"UserAttributes":{"type":"object","properties":{"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"profilePicture":{"type":"string","nullable":true},"jobTitle":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"clientId":{"type":"string","nullable":true}},"additionalProperties":false},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The CollectionAttributes object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"CollectionAttributes":{"type":"object","description":"Collection attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"clientId":{"type":"string"},"description":{"type":"string"},"thumbnailId":{"type":"string"},"thumbnailDescription":{"type":"string"},"path":{"type":"string"},"relatedIds":{"type":"array","items":{"type":"string"}},"favs":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"isPublicCollection":{"type":"boolean"}},"additionalProperties":true}}}} ``` ## The CollectionResource object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"CollectionResource":{"type":"object","properties":{"type":{"type":"string","enum":["collections"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"CollectionAttributes":{"type":"object","description":"Collection attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"clientId":{"type":"string"},"description":{"type":"string"},"thumbnailId":{"type":"string"},"thumbnailDescription":{"type":"string"},"path":{"type":"string"},"relatedIds":{"type":"array","items":{"type":"string"}},"favs":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"isPublicCollection":{"type":"boolean"}},"additionalProperties":true},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The CollectionResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"CollectionResponse":{"type":"object","properties":{"meta":{"type":"object"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"},"data":{"$ref":"#/components/schemas/CollectionResource"}},"required":["data"]},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]},"CollectionResource":{"type":"object","properties":{"type":{"type":"string","enum":["collections"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"CollectionAttributes":{"type":"object","description":"Collection attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"clientId":{"type":"string"},"description":{"type":"string"},"thumbnailId":{"type":"string"},"thumbnailDescription":{"type":"string"},"path":{"type":"string"},"relatedIds":{"type":"array","items":{"type":"string"}},"favs":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"isPublicCollection":{"type":"boolean"}},"additionalProperties":true}}}} ``` ## The CollectionListResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"CollectionListResponse":{"type":"object","properties":{"meta":{"type":"object"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CollectionResource"}}},"required":["meta","data"]},"PaginationLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"first":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}},"CollectionResource":{"type":"object","properties":{"type":{"type":"string","enum":["collections"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/CollectionAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"CollectionAttributes":{"type":"object","description":"Collection attributes. Fields are optional and may vary by endpoint and permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"createdBy":{"type":"string"},"lastModifiedBy":{"type":"string"},"clientId":{"type":"string"},"description":{"type":"string"},"thumbnailId":{"type":"string"},"thumbnailDescription":{"type":"string"},"path":{"type":"string"},"relatedIds":{"type":"array","items":{"type":"string"}},"favs":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"isPublicCollection":{"type":"boolean"}},"additionalProperties":true},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The GroupAttributes object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"GroupAttributes":{"type":"object","description":"Public group attributes.","properties":{"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"clientId":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"lastModifiedBy":{"type":"string"},"userIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}} ``` ## The GroupResource object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"GroupResource":{"type":"object","properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/GroupAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"GroupAttributes":{"type":"object","description":"Public group attributes.","properties":{"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"clientId":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"lastModifiedBy":{"type":"string"},"userIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The GroupResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"GroupResponse":{"type":"object","properties":{"meta":{"type":"object"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"},"data":{"$ref":"#/components/schemas/GroupResource"}},"required":["data"]},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]},"GroupResource":{"type":"object","properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/GroupAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"GroupAttributes":{"type":"object","description":"Public group attributes.","properties":{"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"clientId":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"lastModifiedBy":{"type":"string"},"userIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}} ``` ## The GroupListResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"GroupListResponse":{"type":"object","properties":{"meta":{"type":"object"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupResource"}}},"required":["meta","data"]},"PaginationLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"first":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}},"GroupResource":{"type":"object","properties":{"type":{"type":"string","enum":["groups"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/GroupAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"GroupAttributes":{"type":"object","description":"Public group attributes.","properties":{"name":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"clientId":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"lastModifiedBy":{"type":"string"},"userIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The CreateFolderRequest object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"CreateFolderRequest":{"type":"object","properties":{"path":{"type":"string","description":"Folder path to create. Slashes in the path are treated as folder separators."},"collectionId":{"type":"string","description":"Used when creating folders specific to a collection. Omit this field to create a folder in the Library."},"color":{"type":"string","description":"Optional folder color. Must be one of the colors configured in the client folder settings."},"perms":{"type":"array","description":"Optional upload permissions to apply to the folder. Each permission should follow the structure\n`users/{user ID}:{permission}` or `groups/{group ID}:{permission}`.\n\nAvailable permissions are:\n- `get`: can view\n- `share`: can share\n- `update`: can edit\n- `*`: full access\n\nUse `GET /v1/users` or `GET /v1/groups` to find user or group IDs.\n\nNote: Adding a group to the permission list of a folder grants users in that group the corresponding\npermission to all Assets inside the folder. See https://support.hivo.co/library/folder-management-tools/folder-permissions.\n","maxItems":64,"items":{"type":"string"}}},"required":["path"],"additionalProperties":false}}}} ``` ## The FolderAttributes object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"FolderAttributes":{"type":"object","properties":{"path":{"type":"string"},"collectionId":{"type":"string","nullable":true},"clientId":{"type":"string"},"color":{"type":"string"},"perms":{"type":"array","items":{"type":"string"}},"action":{"type":"string","enum":["create"]},"modifiedCount":{"type":"integer"}},"additionalProperties":true}}}} ``` ## The FolderResource object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"FolderResource":{"type":"object","properties":{"type":{"type":"string","enum":["folders"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/FolderAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"FolderAttributes":{"type":"object","properties":{"path":{"type":"string"},"collectionId":{"type":"string","nullable":true},"clientId":{"type":"string"},"color":{"type":"string"},"perms":{"type":"array","items":{"type":"string"}},"action":{"type":"string","enum":["create"]},"modifiedCount":{"type":"integer"}},"additionalProperties":true},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The FolderResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"FolderResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TopLevelMeta"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"},"data":{"$ref":"#/components/schemas/FolderResource"}},"required":["meta","data"]},"TopLevelMeta":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Server timestamp in milliseconds"},"authentication":{"type":"string","description":"Authentication method, e.g. apiKey"},"links":{"type":"object","properties":{"me":{"type":"string","format":"uri"}}}}},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]},"FolderResource":{"type":"object","properties":{"type":{"type":"string","enum":["folders"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/FolderAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"FolderAttributes":{"type":"object","properties":{"path":{"type":"string"},"collectionId":{"type":"string","nullable":true},"clientId":{"type":"string"},"color":{"type":"string"},"perms":{"type":"array","items":{"type":"string"}},"action":{"type":"string","enum":["create"]},"modifiedCount":{"type":"integer"}},"additionalProperties":true}}}} ``` ## The TaskAttributes object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"TaskAttributes":{"type":"object","description":"Task attributes. Fields are optional and vary by endpoint and user permissions. Checklist items are filtered by user permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"dueDate":{"type":"integer","description":"Unix seconds"},"clientId":{"type":"string"},"ownerEntityId":{"type":"string"},"targetEntityId":{"type":"string"},"archived":{"type":"boolean"},"checklist":{"type":"array","items":{"type":"object"},"description":"Filtered to show only items visible to the requesting user"},"permissionLevel":{"type":"integer","description":"User's permission level on this task"}},"additionalProperties":true}}}} ``` ## The TaskResource object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"TaskResource":{"type":"object","properties":{"type":{"type":"string","enum":["tasks"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/TaskAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"TaskAttributes":{"type":"object","description":"Task attributes. Fields are optional and vary by endpoint and user permissions. Checklist items are filtered by user permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"dueDate":{"type":"integer","description":"Unix seconds"},"clientId":{"type":"string"},"ownerEntityId":{"type":"string"},"targetEntityId":{"type":"string"},"archived":{"type":"boolean"},"checklist":{"type":"array","items":{"type":"object"},"description":"Filtered to show only items visible to the requesting user"},"permissionLevel":{"type":"integer","description":"User's permission level on this task"}},"additionalProperties":true},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The TaskResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"TaskResponse":{"type":"object","properties":{"meta":{"type":"object"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"},"data":{"$ref":"#/components/schemas/TaskResource"}},"required":["data"]},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]},"TaskResource":{"type":"object","properties":{"type":{"type":"string","enum":["tasks"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/TaskAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"TaskAttributes":{"type":"object","description":"Task attributes. Fields are optional and vary by endpoint and user permissions. Checklist items are filtered by user permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"dueDate":{"type":"integer","description":"Unix seconds"},"clientId":{"type":"string"},"ownerEntityId":{"type":"string"},"targetEntityId":{"type":"string"},"archived":{"type":"boolean"},"checklist":{"type":"array","items":{"type":"object"},"description":"Filtered to show only items visible to the requesting user"},"permissionLevel":{"type":"integer","description":"User's permission level on this task"}},"additionalProperties":true}}}} ``` ## The TaskListResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"TaskListResponse":{"type":"object","properties":{"meta":{"type":"object"},"links":{"$ref":"#/components/schemas/PaginationLinks"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskResource"}}},"required":["meta","data"]},"PaginationLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"first":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}},"TaskResource":{"type":"object","properties":{"type":{"type":"string","enum":["tasks"]},"id":{"type":"string"},"attributes":{"$ref":"#/components/schemas/TaskAttributes"},"links":{"$ref":"#/components/schemas/JsonApiLinkage"}},"required":["type","id"]},"TaskAttributes":{"type":"object","description":"Task attributes. Fields are optional and vary by endpoint and user permissions. Checklist items are filtered by user permissions.","properties":{"name":{"type":"string"},"createdAt":{"type":"integer","description":"Unix seconds"},"lastModified":{"type":"integer","description":"Unix seconds"},"dueDate":{"type":"integer","description":"Unix seconds"},"clientId":{"type":"string"},"ownerEntityId":{"type":"string"},"targetEntityId":{"type":"string"},"archived":{"type":"boolean"},"checklist":{"type":"array","items":{"type":"object"},"description":"Filtered to show only items visible to the requesting user"},"permissionLevel":{"type":"integer","description":"User's permission level on this task"}},"additionalProperties":true},"JsonApiLinkage":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/Link"},"thumbnail":{"$ref":"#/components/schemas/LinkObject"}},"additionalProperties":true},"Link":{"oneOf":[{"type":"string","format":"uri"},{"$ref":"#/components/schemas/LinkObject"}]},"LinkObject":{"type":"object","description":"JSON:API link object","properties":{"href":{"type":"string","format":"uri"},"meta":{"type":"object","description":"Non-standard meta-information for the link","properties":{"version":{"type":"string","description":"Asset version name used to generate the link (e.g., thumbnail)"}},"additionalProperties":true}},"required":["href"]}}}} ``` ## The ErrorObject object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"ErrorObject":{"type":"object","properties":{"status":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}},"required":["status","title"]}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TopLevelMeta"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorObject"}}},"required":["errors"]},"TopLevelMeta":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Server timestamp in milliseconds"},"authentication":{"type":"string","description":"Authentication method, e.g. apiKey"},"links":{"type":"object","properties":{"me":{"type":"string","format":"uri"}}}}},"ErrorObject":{"type":"object","properties":{"status":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}},"required":["status","title"]}}}} ``` ## The Error429Response object ```json {"openapi":"3.0.3","info":{"title":"HIVO REST API","version":"1.0.0"},"components":{"schemas":{"Error429Response":{"allOf":[{"$ref":"#/components/schemas/ErrorResponse"},{"type":"object","properties":{"meta":{"type":"object","properties":{"timestamp":{"type":"integer"},"retryAfter":{"type":"integer"}}}}}]},"ErrorResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TopLevelMeta"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorObject"}}},"required":["errors"]},"TopLevelMeta":{"type":"object","properties":{"timestamp":{"type":"integer","description":"Server timestamp in milliseconds"},"authentication":{"type":"string","description":"Authentication method, e.g. apiKey"},"links":{"type":"object","properties":{"me":{"type":"string","format":"uri"}}}}},"ErrorObject":{"type":"object","properties":{"status":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}},"required":["status","title"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://support.hivo.co/api/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.