Dungen Dev API Documentation
This API allows you to use Dungen Dev, an AI model that generates names based on a prompt.
Changelog
1.0 (Latest): Initial commit for API space.
Access
The API can be accessed from
Authentication
API Token
You must include an API token in the request to use this API. The API token should be included in the request body as the apiKey
field.
You can also use the API with the default GET
method.
Endpoint
Generate A Name
Endpoint URL:
HTTP Methods:
Post
Get
Request Body
The request body should be a JSON object with the following properties:
apiKey
: Your API token.prompt
: Your prompt to control name generation, e.g. "A female character name". Your prompt should have a maximum length of50 characters
.nextWords
: The amount of the next tokens. Ranges between1-100
.temperature
: Lower values = more probabilistic, higher values = more creative. Ranges from0.001 - 1
.
Example:
Or, use the GET
method:
The GET
method for this API may not work well, due to the complexities of prompts and URL formatting issues. Preprocessing prompts for a cleaner URL are recommended.
Response
Upon a successful request, using the Dungen Dev AI model you will receive a JSON response with the generated name and your prompt. If the API token is invalid or the request fails, an error message will be included in the response.
Example response:
The response includes the generated name and your prompt. Validation results are excluded since this was a normal API call.
Usage example
Here's a usage example in JavaScript using the fetch
API:
Make sure to replace 'YOUR_API_TOKEN'
with your actual API token.
Error handling
The API may return error responses in case of invalid input or other issues. Be sure to handle errors gracefully in your application. Error responses will include appropriate status codes and error messages in the JSON format.
Parameters
Here are all the available parameters for the API:
`POST` method
apiKey
Your API key, either the developer API key, or your normal API key
false
prompt
Your prompt to control name generation, e.g. "A female character name". Your prompt should have a maximum length of 50 characters
.
false
nextWords
The next tokens number
to generate, ranges from 1 - 100
.
false
temperature
The creativity of the model during generation number
, lower values yield more balanced and probabilistic results, and higher values are more creative. Ranges from 0.001 - 1
.
false
`GET` method
token
Your API key, either the developer API key, or your normal API key
false
prompt
Your prompt to control name generation, e.g. "A female character name". Your prompt should have a maximum length of 50 characters
.
false
nextWords
The next tokens number
to generate, ranges from 1 - 100
.
false
temperature
The creativity of the model during generation number
, lower values yield more balanced and probabilistic results, and higher values are more creative. Ranges from 0.001 - 1
.
false
Here are a few of the error codes, you will receive in responses, to help clarify issues:
Common error codes
400
Missing or invalid parameters. This is when the parameters you passed to the API, do not match the API's expected inputs.
405
Using an invalid method, to access the API.
429
The rate limit is exceeded within the current timeframe.
401
Error during the request. This can be because of insufficient API calls, input errors, or errors arising from the API's logic.
Our APIs are rigorously tested before deployments, to ensure that they do not produce any unintentional errors during production.
We use rate limiting, to protect our API's resources. Rate limiting is implemented on all of our APIs, and follows these general principles:
- interval
: The rate limiting is set to a default interval of 1 minute
.
- amount of requests
: The amount of requests is set to a default of 25 requests
within the given interval.
If the rate limit is exceeded, an error 429
code will be returned, instead of the actual API output.
Common guidelines to use, optimize, and protect your implementation of our APIs.
Do not store/share/expose your API keys
Implement data cleaning, and validation in your code, to ensure inputs are sanitized
Handle API errors gracefully
Use Developer API calls, to help debug your implementation and code
Handle API outputs accordingly. You can see examples of this API's output in the Endpoint section.
Implement code to notify users of actions when using our APIs, such as errors, delays, formatting issues, etc.
Answers to the most common questions and issues when using this API:
Conclusion
That's it! You now know the basics of using the Dungen Dev API. Don't hesitate to contact our support team with further questions or issues.
Last updated
Was this helpful?