{"note":"OpenAPI conversion -- returning structured metadata","name":"giphy-com","description":"Giphy API","version":"1.0","base_url":"https://api.giphy.com/v1","endpoints":10,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Giphy API\n@base https://api.giphy.com/v1\n@version 1.0\n@auth ApiKey api_key in query\n@endpoints 10\n@toc gifs(6), stickers(4)\n\n@group gifs\n@endpoint GET /gifs/search\n@desc Search GIFs\n@required {q: any # Search query term or prhase.}\n@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating., lang: any # Specify default language for regional content; use a 2-letter ISO 639-1 language code.}\n@returns(200) Search results\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /gifs/trending\n@desc Trending GIFs\n@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /gifs/translate\n@desc Translate phrase to GIF\n@required {s: any # Search term.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /gifs/random\n@desc Random GIF\n@optional {tag: any # Filters results by specified tag., rating: any # Filters results by specified rating.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /gifs/{gifId}\n@desc Get GIF by Id\n@required {gifId: any # Filters results by specified GIF ID.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /gifs\n@desc Get GIFs by ID\n@optional {ids: any # Filters results by specified GIF IDs, separated by commas.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endgroup\n\n@group stickers\n@endpoint GET /stickers/search\n@desc Search Stickers\n@required {q: any # Search query term or prhase.}\n@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating., lang: any # Specify default language for regional content; use a 2-letter ISO 639-1 language code.}\n@returns(200) Search results\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /stickers/trending\n@desc Trending Stickers\n@optional {limit: any # The maximum number of records to return., offset: any # An optional results offset., rating: any # Filters results by specified rating.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /stickers/translate\n@desc Translate phrase to Sticker\n@required {s: any # Search term.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endpoint GET /stickers/random\n@desc Random Sticker\n@optional {tag: any # Filters results by specified tag., rating: any # Filters results by specified rating.}\n@returns(200)\n@errors {400: Your request was formatted incorrectly or missing required parameters., 403: You weren't authorized to make your request; most likely this indicates an issue with your API Key., 404: The particular GIF you are requesting was not found. This occurs, for example, if you request a GIF by an id that does not exist., 429: Your API Key is making too many requests. Read about [requesting a Production Key](https://developers.giphy.com/docs/#access) to upgrade your API Key rate limits.}\n\n@endgroup\n\n@end\n"}